Skip to main content
GET
/
api
/
v1
/
client
/
agents
/
{agent_id}
/
runs
Client List Agent Runs
curl --request GET \
  --url https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/runs \
  --header 'Authorization: Bearer <token>'
{
  "runs": [
    {
      "agent_id": 123,
      "run_id": 123,
      "user_defined_id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "files": [
        "<string>"
      ],
      "run_url": "<string>",
      "order": [
        "<string>"
      ],
      "data": {},
      "status": "running",
      "usage": {
        "credits_used": 123
      }
    }
  ],
  "total_pages": 123,
  "page_number": 123,
  "page_size": 123
}

​
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

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

Optionally specify the maximum number of Runs to fetch.

Required range: 0 <= x <= 1000
​
run_ids
integer[] | null

Optionally specify specific Run IDs to fetch.

​
status
enum<string> | null

Optionally specify the type of Runs to fetch, e.g. running or success.

Available options:
running,
success,
failed
​
user_defined_ids
string[] | null

Optionally specify the user_defined_ids of Runs to fetch.

Response

Successful Response

​
runs
AgentRun · object[]
required

The fetched page of Runs from this Agent.

​
total_pages
integer
required

The total number of pages of Runs for this Agent. Use the request arguments page_number and page_size to control which Runs are fetched.

​
page_number
integer
required

The number of the fetched page.

​
page_size
integer
required

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