Client List Agents
curl --request GET \
  --url https://agents-api.kolena.com/api/v1/client/agents \
  --header 'Authorization: Bearer <token>'
{
  "agents": [
    {
      "id": 123,
      "workspace_id": 123,
      "name": "<string>",
      "objective": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "n_runs": 123,
      "prompts": [
        {
          "created": "2025-01-01T00:00:00",
          "documents": [],
          "last_updated_by": "user@example.com",
          "name": "Account number",
          "options": {
            "code_generation": false,
            "prompt": "Find the account number",
            "type": "string",
            "web_search": false
          },
          "updated": "2025-01-01T00:00:00"
        },
        {
          "created": "2025-01-01T00:00:00",
          "documents": [],
          "last_updated_by": "user@example.com",
          "name": "Account info",
          "options": {
            "code_generation": false,
            "fields": [
              "full name",
              "address"
            ],
            "prompt": "Extract form fields",
            "type": "form",
            "web_search": false
          },
          "updated": "2025-01-02T00:00:00"
        }
      ]
    }
  ],
  "total_pages": 123,
  "page_number": 123,
  "page_size": 123
}

​
Rate Limits

This endpoint is rate limited to 600 requests per minute per user.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>. The <token> represents your API key, which must be acquired from the Kolena platform.

Query Parameters

​
page_number
integer
default:0

Optionally specify the index of the Runs page to fetch.

Required range: x >= 0
​
page_size
integer
default:50
Required range: 0 <= x <= 1000

Response

Successful Response

The response is of type object.