List AI Connections

(v1)

GET

Lists the AI connections in your Confident AI project, ordered by name. Fetch a single connection for its full configuration.

GET/v1/ai-connections

curl -X GET "https://api.confident-ai.com/v1/ai-connections" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "aiConnections": [
      {
        "id": "AI-CONNECTION-ID",
        "name": "Production Chatbot",
        "endpoint": "https://api.example.com/chat",
        "active": true
      }
    ]
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Response

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- aiConnectionslist of objects
  The AI connections, ordered by name.
  Show 4 propertiesHide 4 properties
  - idstring
    The unique identifier of the AI connection.
  - namestring
    The name of the AI connection, unique within the project.
  - endpointstring
    The URL Confident AI calls. Null when no endpoint has been configured yet.
  - activeboolean
    Whether Confident AI could successfully call this endpoint. Computed by Confident AI, not writable.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI