Skip to main content
GET
/
api
/
v1
/
client
/
agents
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": [
        {
          "id": 123,
          "name": "<string>",
          "created": "2023-11-07T05:31:56Z",
          "updated": "2023-11-07T05:31:56Z",
          "options": {},
          "documents": [
            {
              "filename": "<string>"
            }
          ],
          "input_prompt_ids": [
            123
          ],
          "last_updated_by": "<string>"
        }
      ]
    }
  ],
  "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

​
agents
Agent · object[]
required

The page of fetched Agents.

​
total_pages
integer
required

The total number of pages of Agents. Use the request arguments page_number and page_size to control which Agents are fetched.

​
page_number
integer
required

The number of the fetched page.

​
page_size
integer
required

The page size, i.e. number of Agents, fetched.