List Agents

List all agents with pagination and filtering.

GET /1/agents

List Agents

cURL

curl --request GET \
  --url https://{APPLICATION_ID}.algolia.net/agent-studio/1/agents \
  --header 'X-Algolia-API-Key: <x-algolia-api-key>' \
  --header 'X-Algolia-Application-Id: <x-algolia-application-id>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "instructions": "<string>",
      "config": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "lastUsedAt": "2023-11-07T05:31:56Z",
      "model": "<string>",
      "systemPrompt": "<string>",
      "tools": [
        {
          "name": "<string>",
          "description": "<string>",
          "inputSchema": {
            "type": "object",
            "properties": {},
            "required": [
              "<string>"
            ]
          },
          "type": "client_side"
        }
      ],
      "templateType": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "totalCount": 123,
    "totalPages": 123
  }
}

Required ACL: settings

Headers

X-Algolia-API-Key · string · required

X-Algolia-Application-Id · string · required

Query Parameters

page · integer · default: 1

Page number

Required range: x >= 1

limit · integer · default: 10

Items per page

Required range: x >= 1

providerId · string<uuid> | null

Filter by provider id

Response

200

application/json

Successful Response

data · AgentWithVersionResponse · object[] · required

Show child attributes

pagination · PaginationMetadata · object · required

Show child attributes