LaunchDarklyApi.AIConfigsBetaApi

All URIs are relative to https://app.launchdarkly.com

Method	HTTP request	Description
deleteAIConfig	DELETE /api/v2/projects/{projectKey}/ai-configs/{configKey}	Delete AI Config
deleteAIConfigVariation	DELETE /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey}	Delete AI Config variation
deleteAITool	DELETE /api/v2/projects/{projectKey}/ai-tools/{toolKey}	Delete AI tool
deleteAgentGraph	DELETE /api/v2/projects/{projectKey}/agent-graphs/{graphKey}	Delete agent graph
deleteModelConfig	DELETE /api/v2/projects/{projectKey}/ai-configs/model-configs/{modelConfigKey}	Delete an AI model config
deleteRestrictedModels	DELETE /api/v2/projects/{projectKey}/ai-configs/model-configs/restricted	Remove AI models from the restricted list
getAIConfig	GET /api/v2/projects/{projectKey}/ai-configs/{configKey}	Get AI Config
getAIConfigMetrics	GET /api/v2/projects/{projectKey}/ai-configs/{configKey}/metrics	Get AI Config metrics
getAIConfigMetricsByVariation	GET /api/v2/projects/{projectKey}/ai-configs/{configKey}/metrics-by-variation	Get AI Config metrics by variation
getAIConfigTargeting	GET /api/v2/projects/{projectKey}/ai-configs/{configKey}/targeting	Show an AI Config's targeting
getAIConfigVariation	GET /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey}	Get AI Config variation
getAIConfigs	GET /api/v2/projects/{projectKey}/ai-configs	List AI Configs
getAITool	GET /api/v2/projects/{projectKey}/ai-tools/{toolKey}	Get AI tool
getAgentGraph	GET /api/v2/projects/{projectKey}/agent-graphs/{graphKey}	Get agent graph
getModelConfig	GET /api/v2/projects/{projectKey}/ai-configs/model-configs/{modelConfigKey}	Get AI model config
listAIToolVersions	GET /api/v2/projects/{projectKey}/ai-tools/{toolKey}/versions	List AI tool versions
listAITools	GET /api/v2/projects/{projectKey}/ai-tools	List AI tools
listAgentGraphs	GET /api/v2/projects/{projectKey}/agent-graphs	List agent graphs
listModelConfigs	GET /api/v2/projects/{projectKey}/ai-configs/model-configs	List AI model configs
patchAIConfig	PATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}	Update AI Config
patchAIConfigTargeting	PATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/targeting	Update AI Config targeting
patchAIConfigVariation	PATCH /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey}	Update AI Config variation
patchAITool	PATCH /api/v2/projects/{projectKey}/ai-tools/{toolKey}	Update AI tool
patchAgentGraph	PATCH /api/v2/projects/{projectKey}/agent-graphs/{graphKey}	Update agent graph
postAIConfig	POST /api/v2/projects/{projectKey}/ai-configs	Create new AI Config
postAIConfigVariation	POST /api/v2/projects/{projectKey}/ai-configs/{configKey}/variations	Create AI Config variation
postAITool	POST /api/v2/projects/{projectKey}/ai-tools	Create an AI tool
postAgentGraph	POST /api/v2/projects/{projectKey}/agent-graphs	Create new agent graph
postModelConfig	POST /api/v2/projects/{projectKey}/ai-configs/model-configs	Create an AI model config
postRestrictedModels	POST /api/v2/projects/{projectKey}/ai-configs/model-configs/restricted	Add AI models to the restricted list

deleteAIConfig

deleteAIConfig(lDAPIVersion, projectKey, configKey)

Delete AI Config

Delete an existing AI Config.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "default"; // String | 
let configKey = "configKey_example"; // String | 
apiInstance.deleteAIConfig(lDAPIVersion, projectKey, configKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
configKey	String

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

deleteAIConfigVariation

deleteAIConfigVariation(lDAPIVersion, projectKey, configKey, variationKey)

Delete AI Config variation

Delete a specific variation of an AI Config by config key and variation key.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let configKey = "configKey_example"; // String | 
let variationKey = "variationKey_example"; // String | 
apiInstance.deleteAIConfigVariation(lDAPIVersion, projectKey, configKey, variationKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
configKey	String
variationKey	String

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

deleteAITool

deleteAITool(lDAPIVersion, projectKey, toolKey)

Delete AI tool

Delete an existing AI tool.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let toolKey = "toolKey_example"; // String | 
apiInstance.deleteAITool(lDAPIVersion, projectKey, toolKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
toolKey	String

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

deleteAgentGraph

deleteAgentGraph(lDAPIVersion, projectKey, graphKey)

Delete agent graph

Delete an existing agent graph and all of its edges.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let graphKey = "graphKey_example"; // String | 
apiInstance.deleteAgentGraph(lDAPIVersion, projectKey, graphKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
graphKey	String

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

deleteModelConfig

deleteModelConfig(lDAPIVersion, projectKey, modelConfigKey)

Delete an AI model config

Delete an AI model config.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "default"; // String | 
let modelConfigKey = "modelConfigKey_example"; // String | 
apiInstance.deleteModelConfig(lDAPIVersion, projectKey, modelConfigKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
modelConfigKey	String

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

deleteRestrictedModels

deleteRestrictedModels(lDAPIVersion, projectKey, restrictedModelsRequest)

Remove AI models from the restricted list

Remove AI models, by key, from the restricted list.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "default"; // String | 
let restrictedModelsRequest = new LaunchDarklyApi.RestrictedModelsRequest(); // RestrictedModelsRequest | List of AI model keys to remove from the restricted list
apiInstance.deleteRestrictedModels(lDAPIVersion, projectKey, restrictedModelsRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
restrictedModelsRequest	RestrictedModelsRequest	List of AI model keys to remove from the restricted list

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

getAIConfig

AIConfig getAIConfig(lDAPIVersion, projectKey, configKey)

Get AI Config

Retrieve a specific AI Config by its key.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let configKey = "configKey_example"; // String | 
apiInstance.getAIConfig(lDAPIVersion, projectKey, configKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
configKey	String

Return type

AIConfig

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAIConfigMetrics

Metrics getAIConfigMetrics(lDAPIVersion, projectKey, configKey, from, to, env)

Get AI Config metrics

Retrieve usage metrics for an AI Config by config key.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let configKey = "configKey_example"; // String | 
let from = 56; // Number | The starting time, as milliseconds since epoch (inclusive).
let to = 56; // Number | The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
let env = "env_example"; // String | An environment key. Only metrics from this environment will be included.
apiInstance.getAIConfigMetrics(lDAPIVersion, projectKey, configKey, from, to, env, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
configKey	String
from	Number	The starting time, as milliseconds since epoch (inclusive).
to	Number	The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
env	String	An environment key. Only metrics from this environment will be included.

Return type

Metrics

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAIConfigMetricsByVariation

[MetricByVariation] getAIConfigMetricsByVariation(lDAPIVersion, projectKey, configKey, from, to, env)

Get AI Config metrics by variation

Retrieve usage metrics for an AI Config by config key, with results split by variation.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let configKey = "configKey_example"; // String | 
let from = 56; // Number | The starting time, as milliseconds since epoch (inclusive).
let to = 56; // Number | The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
let env = "env_example"; // String | An environment key. Only metrics from this environment will be included.
apiInstance.getAIConfigMetricsByVariation(lDAPIVersion, projectKey, configKey, from, to, env, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
configKey	String
from	Number	The starting time, as milliseconds since epoch (inclusive).
to	Number	The ending time, as milliseconds since epoch (exclusive). May not be more than 100 days after `from`.
env	String	An environment key. Only metrics from this environment will be included.

Return type

[MetricByVariation]

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAIConfigTargeting

AIConfigTargeting getAIConfigTargeting(lDAPIVersion, projectKey, configKey)

Show an AI Config's targeting

Retrieves a specific AI Config's targeting by its key

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let configKey = "configKey_example"; // String | 
apiInstance.getAIConfigTargeting(lDAPIVersion, projectKey, configKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
configKey	String

Return type

AIConfigTargeting

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAIConfigVariation

AIConfigVariationsResponse getAIConfigVariation(lDAPIVersion, projectKey, configKey, variationKey)

Get AI Config variation

Get an AI Config variation by key. The response includes all variation versions for the given variation key.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "default"; // String | 
let configKey = "default"; // String | 
let variationKey = "default"; // String | 
apiInstance.getAIConfigVariation(lDAPIVersion, projectKey, configKey, variationKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
configKey	String
variationKey	String

Return type

AIConfigVariationsResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAIConfigs

AIConfigs getAIConfigs(lDAPIVersion, projectKey, opts)

List AI Configs

Get a list of all AI Configs in the given project.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "default"; // String | 
let opts = {
  'sort': "sort_example", // String | A sort to apply to the list of AI Configs.
  'limit': 56, // Number | The number of AI Configs to return.
  'offset': 56, // Number | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
  'filter': "filter_example" // String | A filter to apply to the list of AI Configs.
};
apiInstance.getAIConfigs(lDAPIVersion, projectKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
lDAPIVersion	String	Version of the endpoint.
projectKey	String
sort	String	A sort to apply to the list of AI Configs.	[optional]
limit	Number	The number of AI Configs to return.	[optional]
offset	Number	Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]
filter	String	A filter to apply to the list of AI Configs.	[optional]

Return type

AIConfigs

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAITool

AITool getAITool(lDAPIVersion, projectKey, toolKey)

Get AI tool

Retrieve a specific AI tool by its key.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let toolKey = "toolKey_example"; // String | 
apiInstance.getAITool(lDAPIVersion, projectKey, toolKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
toolKey	String

Return type

AITool

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAgentGraph

AgentGraph getAgentGraph(lDAPIVersion, projectKey, graphKey)

Get agent graph

Retrieve a specific agent graph by its key, including its edges.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let graphKey = "graphKey_example"; // String | 
apiInstance.getAgentGraph(lDAPIVersion, projectKey, graphKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
graphKey	String

Return type

AgentGraph

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getModelConfig

ModelConfig getModelConfig(lDAPIVersion, projectKey, modelConfigKey)

Get AI model config

Get an AI model config by key.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "default"; // String | 
let modelConfigKey = "default"; // String | 
apiInstance.getModelConfig(lDAPIVersion, projectKey, modelConfigKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
modelConfigKey	String

Return type

ModelConfig

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

listAIToolVersions

AITools listAIToolVersions(lDAPIVersion, projectKey, toolKey, opts)

List AI tool versions

Get a list of all versions of an AI tool in the given project.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let toolKey = "toolKey_example"; // String | 
let opts = {
  'sort': "sort_example", // String | A sort to apply to the list of AI Configs.
  'limit': 56, // Number | The number of AI Configs to return.
  'offset': 56 // Number | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
};
apiInstance.listAIToolVersions(lDAPIVersion, projectKey, toolKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
lDAPIVersion	String	Version of the endpoint.
projectKey	String
toolKey	String
sort	String	A sort to apply to the list of AI Configs.	[optional]
limit	Number	The number of AI Configs to return.	[optional]
offset	Number	Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]

Return type

AITools

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

listAITools

AITools listAITools(lDAPIVersion, projectKey, opts)

List AI tools

Get a list of all AI tools in the given project.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let opts = {
  'sort': "sort_example", // String | A sort to apply to the list of AI Configs.
  'limit': 56, // Number | The number of AI Configs to return.
  'offset': 56, // Number | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
  'filter': "filter_example" // String | A filter to apply to the list of AI Configs.
};
apiInstance.listAITools(lDAPIVersion, projectKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
lDAPIVersion	String	Version of the endpoint.
projectKey	String
sort	String	A sort to apply to the list of AI Configs.	[optional]
limit	Number	The number of AI Configs to return.	[optional]
offset	Number	Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]
filter	String	A filter to apply to the list of AI Configs.	[optional]

Return type

AITools

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

listAgentGraphs

AgentGraphs listAgentGraphs(lDAPIVersion, projectKey, opts)

List agent graphs

Get a list of all agent graphs in the given project. Returns metadata only, without edge data.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let opts = {
  'limit': 56, // Number | The number of AI Configs to return.
  'offset': 56 // Number | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
};
apiInstance.listAgentGraphs(lDAPIVersion, projectKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
lDAPIVersion	String	Version of the endpoint.
projectKey	String
limit	Number	The number of AI Configs to return.	[optional]
offset	Number	Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.	[optional]

Return type

AgentGraphs

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

listModelConfigs

[ModelConfig] listModelConfigs(lDAPIVersion, projectKey, opts)

List AI model configs

Get all AI model configs for a project.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "default"; // String | 
let opts = {
  'restricted': true // Boolean | Whether to return only restricted models
};
apiInstance.listModelConfigs(lDAPIVersion, projectKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
lDAPIVersion	String	Version of the endpoint.
projectKey	String
restricted	Boolean	Whether to return only restricted models	[optional]

Return type

[ModelConfig]

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

patchAIConfig

AIConfig patchAIConfig(lDAPIVersion, projectKey, configKey, opts)

Update AI Config

Edit an existing AI Config. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here's an example: ``` { "description": "Example updated description", "tags": ["new-tag"] } ```

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let configKey = "configKey_example"; // String | 
let opts = {
  'aIConfigPatch': new LaunchDarklyApi.AIConfigPatch() // AIConfigPatch | AI Config object to update
};
apiInstance.patchAIConfig(lDAPIVersion, projectKey, configKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
lDAPIVersion	String	Version of the endpoint.
projectKey	String
configKey	String
aIConfigPatch	AIConfigPatch	AI Config object to update	[optional]

Return type

AIConfig

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

patchAIConfigTargeting

AIConfigTargeting patchAIConfigTargeting(lDAPIVersion, projectKey, configKey, opts)

Update AI Config targeting

Perform a partial update to an AI Config's targeting. The request body must be a valid semantic patch. ### Using semantic patches on an AI Config To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read Updates using semantic patch. The body of a semantic patch request for updating an AI Config's targeting takes the following properties: * `comment` (string): (Optional) A description of the update. * `environmentKey` (string): The key of the LaunchDarkly environment. * `instructions` (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a `kind` property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object. The body of a single semantic patch can contain many different instructions. ### Instructions Semantic patch requests support the following `kind` instructions for updating AI Configs. <details> <summary>Click to expand instructions for <strong>working with targeting and variations</strong> for AI Configs</summary> #### addClauses Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the AI Config. - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "addClauses", "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29", "clauses": [{ "contextKind": "user", "attribute": "country", "op": "in", "negate": false, "values": ["USA", "Canada"] }] }] } ``` #### addRule Adds a new targeting rule to the AI Config. The rule may contain `clauses` and serve the variation that `variationId` indicates, or serve a percentage rollout that `rolloutWeights`, `rolloutBucketBy`, and `rolloutContextKind` indicate. If you set `beforeRuleId`, this adds the new rule before the indicated rule. Otherwise, adds the new rule to the end of the list. ##### Parameters - `clauses`: Array of clause objects, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. - `beforeRuleId`: (Optional) ID of a rule. - Either - `variationId`: ID of a variation. or - `rolloutWeights`: (Optional) Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here's an example that uses a `variationId`: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "addRule", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00", "clauses": [{ "contextKind": "organization", "attribute": "located_in", "op": "in", "negate": false, "values": ["Sweden", "Norway"] }] }] } ``` Here's an example that uses a percentage rollout: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "addRule", "clauses": [{ "contextKind": "organization", "attribute": "located_in", "op": "in", "negate": false, "values": ["Sweden", "Norway"] }], "rolloutContextKind": "organization", "rolloutWeights": { "2f43f67c-3e4e-4945-a18a-26559378ca00": 15000, // serve 15% this variation "e5830889-1ec5-4b0c-9cc9-c48790090c43": 85000 // serve 85% this variation } }] } ``` #### addTargets Adds context keys to the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Returns an error if this causes the AI Config to target the same context key in multiple variations. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a variation. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "addTargets", "values": ["context-key-123abc", "context-key-456def"], "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00" }] } ``` #### addValuesToClause Adds `values` to the values of the clause that `ruleId` and `clauseId` indicate. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule in the AI Config. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "addValuesToClause", "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29", "clauseId": "10a58772-3121-400f-846b-b8a04e8944ed", "values": ["beta_testers"] }] } ``` #### clearTargets Removes all individual targets from the variation that `variationId` specifies. This includes both user and non-user targets. ##### Parameters - `variationId`: ID of a variation. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [ { "kind": "clearTargets", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00" } ] } ``` #### removeClauses Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule. - `clauseIds`: Array of IDs of clauses in the rule. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "removeClauses", "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29", "clauseIds": ["10a58772-3121-400f-846b-b8a04e8944ed", "36a461dc-235e-4b08-97b9-73ce9365873e"] }] } ``` #### removeRule Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [ { "kind": "removeRule", "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29" } ] } ``` #### removeTargets Removes context keys from the individual context targets for the context kind that `contextKind` specifies and the variation that `variationId` specifies. Does nothing if the flag does not target the context keys. ##### Parameters - `values`: List of context keys. - `contextKind`: (Optional) Context kind to target, defaults to `user` - `variationId`: ID of a variation. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "removeTargets", "values": ["context-key-123abc", "context-key-456def"], "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00" }] } ``` #### removeValuesFromClause Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. Does not update the context kind, attribute, or operator. ##### Parameters - `ruleId`: ID of a rule. - `clauseId`: ID of a clause in that rule. - `values`: Array of strings, case sensitive. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "removeValuesFromClause", "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29", "clauseId": "10a58772-3121-400f-846b-b8a04e8944ed", "values": ["beta_testers"] }] } ``` #### reorderRules Rearranges the rules to match the order given in `ruleIds`. Returns an error if `ruleIds` does not match the current set of rules on the AI Config. ##### Parameters - `ruleIds`: Array of IDs of all rules. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "reorderRules", "ruleIds": ["a902ef4a-2faf-4eaf-88e1-ecc356708a29", "63c238d1-835d-435e-8f21-c8d5e40b2a3d"] }] } ``` #### replaceRules Removes all targeting rules for the AI Config and replaces them with the list you provide. ##### Parameters - `rules`: A list of rules. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [ { "kind": "replaceRules", "rules": [ { "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00", "description": "My new rule", "clauses": [ { "contextKind": "user", "attribute": "segmentMatch", "op": "segmentMatch", "values": ["test"] } ] } ] } ] } ``` #### replaceTargets Removes all existing targeting and replaces it with the list of targets you provide. ##### Parameters - `targets`: A list of context targeting. Each item in the list includes an optional `contextKind` that defaults to `user`, a required `variationId`, and a required list of `values`. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [ { "kind": "replaceTargets", "targets": [ { "contextKind": "user", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00", "values": ["user-key-123abc"] }, { "contextKind": "device", "variationId": "e5830889-1ec5-4b0c-9cc9-c48790090c43", "values": ["device-key-456def"] } ] } ] } ``` #### updateClause Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule. - `clauseId`: ID of a clause in that rule. - `clause`: New `clause` object, with `contextKind` (string), `attribute` (string), `op` (string), `negate` (boolean), and `values` (array of strings, numbers, or dates) properties. The `contextKind`, `attribute`, and `values` are case sensitive. The `op` must be lower-case. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "updateClause", "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29", "clauseId": "10c7462a-2062-45ba-a8bb-dfb3de0f8af5", "clause": { "contextKind": "user", "attribute": "country", "op": "in", "negate": false, "values": ["Mexico", "Canada"] } }] } ``` #### updateDefaultVariation Updates the default on or off variation of the AI Config. ##### Parameters - `onVariationValue`: (Optional) The value of the variation of the new on variation. - `offVariationValue`: (Optional) The value of the variation of the new off variation Here's an example: ```json { "instructions": [ { "kind": "updateDefaultVariation", "OnVariationValue": true, "OffVariationValue": false } ] } ``` #### updateFallthroughVariationOrRollout Updates the default or "fallthrough" rule for the AI Config, which the AI Config serves when a context matches none of the targeting rules. The rule can serve either the variation that `variationId` indicates, or a percentage rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `variationId`: ID of a variation. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here's an example that uses a `variationId`: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "updateFallthroughVariationOrRollout", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00" }] } ``` Here's an example that uses a percentage rollout: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "updateFallthroughVariationOrRollout", "rolloutContextKind": "user", "rolloutWeights": { "2f43f67c-3e4e-4945-a18a-26559378ca00": 15000, // serve 15% this variation "e5830889-1ec5-4b0c-9cc9-c48790090c43": 85000 // serve 85% this variation } }] } ``` #### updateOffVariation Updates the default off variation to `variationId`. The AI Config serves the default off variation when the AI Config's targeting is Off. ##### Parameters - `variationId`: ID of a variation. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [ { "kind": "updateOffVariation", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00" } ] } ``` #### updateRuleDescription Updates the description of the targeting rule. ##### Parameters - `description`: The new human-readable description for this rule. - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the AI Config. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "updateRuleDescription", "description": "New rule description", "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29" }] } ``` #### updateRuleTrackEvents Updates whether or not LaunchDarkly tracks events for the AI Config associated with this rule. ##### Parameters - `ruleId`: The ID of the rule. You can retrieve this by making a GET request for the AI Config. - `trackEvents`: Whether or not events are tracked. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "updateRuleTrackEvents", "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29", "trackEvents": true }] } ``` #### updateRuleVariationOrRollout Updates what `ruleId` serves when its clauses evaluate to true. The rule can serve either the variation that `variationId` indicates, or a percent rollout that `rolloutWeights` and `rolloutBucketBy` indicate. ##### Parameters - `ruleId`: ID of a rule. - `variationId`: ID of a variation. or - `rolloutWeights`: Map of `variationId` to weight, in thousandths of a percent (0-100000). - `rolloutBucketBy`: (Optional) Context attribute available in the specified `rolloutContextKind`. - `rolloutContextKind`: (Optional) Context kind, defaults to `user` Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [{ "kind": "updateRuleVariationOrRollout", "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29", "variationId": "2f43f67c-3e4e-4945-a18a-26559378ca00" }] } ``` #### updateTrackEvents Updates whether or not LaunchDarkly tracks events for the AI Config, for all rules. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [ { "kind": "updateTrackEvents", "trackEvents": true } ] } ``` #### updateTrackEventsFallthrough Updates whether or not LaunchDarkly tracks events for the AI Config, for the default rule. ##### Parameters - `trackEvents`: Whether or not events are tracked. Here's an example: ```json { "environmentKey": "environment-key-123abc", "instructions": [ { "kind": "updateTrackEventsFallthrough", "trackEvents": true } ] } ``` </details>

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let configKey = "configKey_example"; // String | 
let opts = {
  'aIConfigTargetingPatch': new LaunchDarklyApi.AIConfigTargetingPatch() // AIConfigTargetingPatch | AI Config targeting semantic patch instructions
};
apiInstance.patchAIConfigTargeting(lDAPIVersion, projectKey, configKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
lDAPIVersion	String	Version of the endpoint.
projectKey	String
configKey	String
aIConfigTargetingPatch	AIConfigTargetingPatch	AI Config targeting semantic patch instructions	[optional]

Return type

AIConfigTargeting

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

patchAIConfigVariation

AIConfigVariation patchAIConfigVariation(lDAPIVersion, projectKey, configKey, variationKey, opts)

Update AI Config variation

Edit an existing variation of an AI Config. This creates a new version of the variation. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here's an example: ``` { "messages": [ { "role": "system", "content": "The new message" } ] } ```

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let configKey = "configKey_example"; // String | 
let variationKey = "variationKey_example"; // String | 
let opts = {
  'aIConfigVariationPatch': new LaunchDarklyApi.AIConfigVariationPatch() // AIConfigVariationPatch | AI Config variation object to update
};
apiInstance.patchAIConfigVariation(lDAPIVersion, projectKey, configKey, variationKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
lDAPIVersion	String	Version of the endpoint.
projectKey	String
configKey	String
variationKey	String
aIConfigVariationPatch	AIConfigVariationPatch	AI Config variation object to update	[optional]

Return type

AIConfigVariation

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

patchAITool

AITool patchAITool(lDAPIVersion, projectKey, toolKey, opts)

Update AI tool

Edit an existing AI tool.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let toolKey = "toolKey_example"; // String | 
let opts = {
  'aIToolPatch': new LaunchDarklyApi.AIToolPatch() // AIToolPatch | AI tool object to update
};
apiInstance.patchAITool(lDAPIVersion, projectKey, toolKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
lDAPIVersion	String	Version of the endpoint.
projectKey	String
toolKey	String
aIToolPatch	AIToolPatch	AI tool object to update	[optional]

Return type

AITool

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

patchAgentGraph

AgentGraph patchAgentGraph(lDAPIVersion, projectKey, graphKey, opts)

Update agent graph

Edit an existing agent graph. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. If the update includes `rootConfigKey` or `edges`, both must be present and will be treated as full replacements.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let graphKey = "graphKey_example"; // String | 
let opts = {
  'agentGraphPatch': new LaunchDarklyApi.AgentGraphPatch() // AgentGraphPatch | Agent graph object to update
};
apiInstance.patchAgentGraph(lDAPIVersion, projectKey, graphKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
lDAPIVersion	String	Version of the endpoint.
projectKey	String
graphKey	String
agentGraphPatch	AgentGraphPatch	Agent graph object to update	[optional]

Return type

AgentGraph

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

postAIConfig

AIConfig postAIConfig(lDAPIVersion, projectKey, aIConfigPost)

Create new AI Config

Create a new AI Config within the given project.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let aIConfigPost = new LaunchDarklyApi.AIConfigPost(); // AIConfigPost | AI Config object to create
apiInstance.postAIConfig(lDAPIVersion, projectKey, aIConfigPost, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
aIConfigPost	AIConfigPost	AI Config object to create

Return type

AIConfig

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

postAIConfigVariation

AIConfigVariation postAIConfigVariation(lDAPIVersion, projectKey, configKey, aIConfigVariationPost)

Create AI Config variation

Create a new variation for a given AI Config. The <code>model</code> in the request body requires a <code>modelName</code> and <code>parameters</code>, for example: ``` "model": { "modelName": "claude-3-opus-20240229", "parameters": { "max_tokens": 1024 } } ```

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let configKey = "configKey_example"; // String | 
let aIConfigVariationPost = new LaunchDarklyApi.AIConfigVariationPost(); // AIConfigVariationPost | AI Config variation object to create
apiInstance.postAIConfigVariation(lDAPIVersion, projectKey, configKey, aIConfigVariationPost, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
configKey	String
aIConfigVariationPost	AIConfigVariationPost	AI Config variation object to create

Return type

AIConfigVariation

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

postAITool

AITool postAITool(lDAPIVersion, projectKey, aIToolPost)

Create an AI tool

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let aIToolPost = new LaunchDarklyApi.AIToolPost(); // AIToolPost | AI tool object to create
apiInstance.postAITool(lDAPIVersion, projectKey, aIToolPost, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
aIToolPost	AIToolPost	AI tool object to create

Return type

AITool

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

postAgentGraph

AgentGraph postAgentGraph(lDAPIVersion, projectKey, agentGraphPost)

Create new agent graph

Create a new agent graph within the given project.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "projectKey_example"; // String | 
let agentGraphPost = new LaunchDarklyApi.AgentGraphPost(); // AgentGraphPost | Agent graph object to create
apiInstance.postAgentGraph(lDAPIVersion, projectKey, agentGraphPost, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
agentGraphPost	AgentGraphPost	Agent graph object to create

Return type

AgentGraph

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

postModelConfig

ModelConfig postModelConfig(lDAPIVersion, projectKey, modelConfigPost)

Create an AI model config

Create an AI model config. You can use this in any variation for any AI Config in your project.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "default"; // String | 
let modelConfigPost = new LaunchDarklyApi.ModelConfigPost(); // ModelConfigPost | AI model config object to create
apiInstance.postModelConfig(lDAPIVersion, projectKey, modelConfigPost, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
modelConfigPost	ModelConfigPost	AI model config object to create

Return type

ModelConfig

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

postRestrictedModels

RestrictedModelsResponse postRestrictedModels(lDAPIVersion, projectKey, restrictedModelsRequest)

Add AI models to the restricted list

Add AI models, by key, to the restricted list. Keys are included in the response from the List AI model configs endpoint.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.AIConfigsBetaApi();
let lDAPIVersion = "lDAPIVersion_example"; // String | Version of the endpoint.
let projectKey = "default"; // String | 
let restrictedModelsRequest = new LaunchDarklyApi.RestrictedModelsRequest(); // RestrictedModelsRequest | List of AI model keys to add to the restricted list.
apiInstance.postRestrictedModels(lDAPIVersion, projectKey, restrictedModelsRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description
lDAPIVersion	String	Version of the endpoint.
projectKey	String
restrictedModelsRequest	RestrictedModelsRequest	List of AI model keys to add to the restricted list.

Return type

RestrictedModelsResponse

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

FilesExpand file tree

AIConfigsBetaApi.md

Latest commit

History

AIConfigsBetaApi.md

File metadata and controls

LaunchDarklyApi.AIConfigsBetaApi

deleteAIConfig

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAIConfigVariation

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAITool

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAgentGraph

Example

Parameters

Return type

Authorization

HTTP request headers

deleteModelConfig

Example

Parameters

Return type

Authorization

HTTP request headers

deleteRestrictedModels

Example

Parameters

Return type

Authorization

HTTP request headers

getAIConfig

Example

Parameters

Return type

Authorization

HTTP request headers

getAIConfigMetrics

Example

Parameters

Return type

Authorization

HTTP request headers

getAIConfigMetricsByVariation

Example

Parameters

Return type

Authorization

HTTP request headers

getAIConfigTargeting

Example

Parameters

Return type

Authorization

HTTP request headers

getAIConfigVariation

Example

Parameters

Return type

Authorization

HTTP request headers

getAIConfigs

Example

Parameters

Return type

Authorization

HTTP request headers

getAITool