Get AI Config

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Retrieve a specific AI Config by its key.

GET /api/v2/projects/{projectKey}/ai-configs/{configKey}

Get AI Config

cURL

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/{configKey} \
  --header 'Authorization: <api-key>'

200

{
  "_maintainer": {
    "kind": "kind"
  },
  "_links": {
    "parent": {
      "href": "href",
      "type": "type"
    },
    "self": {
      "href": "href",
      "type": "type"
    }
  },
  "description": "description",
  "evaluationMetricKey": "evaluationMetricKey",
  "version": 0,
  "tags": [
    "tags",
    "tags"
  ],
  "dependencies": [
    {
      "type": "agent-graph",
      "key": "key"
    },
    {
      "type": "agent-graph",
      "key": "key"
    }
  ],
  "mode": "completion",
  "createdAt": 9,
  "evaluationMetricKeys": [
    "evaluationMetricKeys",
    "evaluationMetricKeys"
  ],
  "_access": {
    "allowed": [
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      },
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      }
    ],
    "denied": [
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      },
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      }
    ]
  },
  "variations": [
    {
      "judgeConfiguration": {
        "judges": [
          {
            "samplingRate": 0.7061401,
            "judgeConfigKey": "judgeConfigKey"
          },
          {
            "samplingRate": 0.7061401,
            "judgeConfigKey": "judgeConfigKey"
          }
        ]
      },
      "instructions": "instructions",
      "color": "color",
      "_links": {
        "parent": {
          "href": "href",
          "type": "type"
        }
      },
      "description": "description",
      "modelConfigKey": "modelConfigKey",
      "judgingConfigKeys": [
        "judgingConfigKeys",
        "judgingConfigKeys"
      ],
      "version": 1,
      "tools": [
        {
          "customParameters": {
            "key": ""
          },
          "version": 2,
          "key": "key"
        },
        {
          "customParameters": {
            "key": ""
          },
          "version": 2,
          "key": "key"
        }
      ],
      "createdAt": 6,
      "_publishedAt": 5,
      "_archivedAt": 5,
      "name": "name",
      "messages": [
        {
          "role": "role",
          "content": "content"
        },
        {
          "role": "role",
          "content": "content"
        }
      ],
      "comment": "comment",
      "model": "{}",
      "_id": "_id",
      "state": "state",
      "key": "key"
    },
    {
      "judgeConfiguration": {
        "judges": [
          {
            "samplingRate": 0.7061401,
            "judgeConfigKey": "judgeConfigKey"
          },
          {
            "samplingRate": 0.7061401,
            "judgeConfigKey": "judgeConfigKey"
          }
        ]
      },
      "instructions": "instructions",
      "color": "color",
      "_links": {
        "parent": {
          "href": "href",
          "type": "type"
        }
      },
      "description": "description",
      "modelConfigKey": "modelConfigKey",
      "judgingConfigKeys": [
        "judgingConfigKeys",
        "judgingConfigKeys"
      ],
      "version": 1,
      "tools": [
        {
          "customParameters": {
            "key": ""
          },
          "version": 2,
          "key": "key"
        },
        {
          "customParameters": {
            "key": ""
          },
          "version": 2,
          "key": "key"
        }
      ],
      "createdAt": 6,
      "_publishedAt": 5,
      "_archivedAt": 5,
      "name": "name",
      "messages": [
        {
          "role": "role",
          "content": "content"
        },
        {
          "role": "role",
          "content": "content"
        }
      ],
      "comment": "comment",
      "model": "{}",
      "_id": "_id",
      "state": "state",
      "key": "key"
    }
  ],
  "name": "name",
  "key": "key",
  "isInverted": true,
  "updatedAt": 3
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string · required

configKey · string · required

Response

200

application/json

AI Config found

description · string · required

key · string · required

name · string · required

tags · string[] · required

version · integer · required

variations · object[] · required

Show child attributes

createdAt · integer<int64> · required

updatedAt · integer<int64> · required

_access · object

Show child attributes

Example:

{
  "allowed": [
    {
      "reason": {
        "role_name": "role_name",
        "notActions": [null, null],
        "notResources": ["notResources", "notResources"],
        "effect": "allow",
        "resources": ["proj/*:env/*;qa_*:/flag/*"],
        "actions": ["*"]
      },
      "action": "action"
    },
    {
      "reason": {
        "role_name": "role_name",
        "notActions": [null, null],
        "notResources": ["notResources", "notResources"],
        "effect": "allow",
        "resources": ["proj/*:env/*;qa_*:/flag/*"],
        "actions": ["*"]
      },
      "action": "action"
    }
  ],
  "denied": [
    {
      "reason": {
        "role_name": "role_name",
        "notActions": [null, null],
        "notResources": ["notResources", "notResources"],
        "effect": "allow",
        "resources": ["proj/*:env/*;qa_*:/flag/*"],
        "actions": ["*"]
      },
      "action": "action"
    },
    {
      "reason": {
        "role_name": "role_name",
        "notActions": [null, null],
        "notResources": ["notResources", "notResources"],
        "effect": "allow",
        "resources": ["proj/*:env/*;qa_*:/flag/*"],
        "actions": ["*"]
      },
      "action": "action"
    }
  ]
}

_links · object

The location and content type of related resources

Show child attributes

Example:

{
  "parent": { "href": "href", "type": "type" },
  "self": { "href": "href", "type": "type" }
}

_maintainer · object

Option 1

Option 2

Show child attributes

Example:

{ "kind": "kind" }

mode · enum<string> · default: completion

Available options: agent, completion, judge

evaluationMetricKey · string

Evaluation metric key for this AI Config

evaluationMetricKeys · string[] · deprecated

List of evaluation metric keys for this AI Config

isInverted · boolean

Whether the evaluation metric is inverted, meaning a lower value is better if set as true

dependencies · object[]

Resources that depend on this AI Config, grouped by type

Show child attributes