List Connections

GEThttps://api.confident-ai.com/v2/ai-connections

Lists the AI connections in your Confident AI project one page at a time, ordered by name. Each connection is returned with just its endpoint and whether it is active; retrieve one by id for its full configuration. Requires the Starter plan or above.

GET/v2/ai-connections

curl -X GET "https://api.confident-ai.com/v2/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
      }
    ],
    "totalAIConnections": 3,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/ai-connections",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of results per page, at most 100. Defaults to 25.

Response

List Connections succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of AI connections, with the total across all pages.
Show 4 propertiesHide 4 properties
- aiConnectionslist of objects
  The AI connections for the current page, ordered by name.
  Show 4 propertiesHide 4 properties
  - idstring
    The id of the AI connection, generated by Confident AI.
  - namestring
    The name of the AI connection, unique within the project.
  - endpointstring | null
    The URL Confident AI calls, or null when no endpoint has been configured.
  - activeboolean
    Whether Confident AI could last reach your application and read an answer out of its response. Computed by Confident AI, not writable.
- totalAIConnectionsinteger
  The total number of AI connections in this project.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of AI connections per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI