Skip to main content
GET
/
api
/
v1
/
client
/
agents
/
{agent_id}
Client Get Agent
curl --request GET \
  --url https://agents-api.kolena.com/api/v1/client/agents/{agent_id} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
    }
  ]
}

​
Rate Limits

This endpoint is rate limited to 1,200 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.

Path Parameters

​
agent_id
integer
required

Response

Successful Response

​
id
integer
required

The ID of this Agent.

​
workspace_id
integer
required

The ID of the workspace hosting this Agent.

​
name
string
required

The name of this Agent.

​
objective
string
required

A short description of this Agent's objective, e.g. "Extract key information from leases and addendum documents".

​
created
string<date-time>
required

When this Agent was created, formatted as an ISO 8601 timestamp (e.g. 2025-11-13T15:53:59.655033+00:00)

​
updated
string<date-time>
required

When this Agent was last updated, formatted as an ISO 8601 timestamp (e.g. 2025-11-13T15:53:59.655033+00:00)

​
created_by
string
required

The email address of the user who created this Agent.

​
n_runs
integer
required

The number of times this Agent has been Run.

​
prompts
Prompt · object[]
required

The Prompts configured for this Agent.