Skip to main content
Client Add Agent Run And Wait
curl --request POST \
  --url https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/runs/wait \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'files=<string>' \
  --form files.items='@example-file'
{
  "agent_id": 123,
  "run_id": 123,
  "user_defined_id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "completed": "2023-11-07T05:31:56Z",
  "files": [
    "<string>"
  ],
  "run_url": "<string>",
  "order": [
    "<string>"
  ],
  "data": {},
  "usage": {
    "credits_used": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.agents.kolena.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Rate Limits

This endpoint is rate limited based on your Organization tier:
Organization TierRate Limit (requests/minute)
Starter10
Professional20
Enterprise40
Rate limits are applied per Organization.

​
Behavior

This endpoint accepts data to create an Agent Run. If the results from all Prompts are available within the requested timeout period, the response will include the completed Agent Run with results. Otherwise, the response will contain a status of running and a run_id which can be used to fetch the results later.
Compared to the Add Agent Run endpoint, this endpoint is synchronous and attempts to wait for the Agent Run to complete before returning results. Requests are processed with higher priority when resources are available, but the endpoint is rate limited more strictly.

​
Handling Timeouts

If the Agent Run takes longer than the request timeout period to complete, this endpoint will return the Agent Run in a running status. In such cases:
  1. The response will indicate the Run is still in progress
  2. You can use the Get Agent Run endpoint to fetch the results later by providing the same run_id

​
Tips to Avoid Timeouts

To reduce the likelihood of timeouts when using this endpoint:
  1. Use smaller inputs - Upload inputs with minimal content and fewer prompts
  2. Disable “Data Analysis” - If your Agent has Data Analysis enabled, consider disabling it for faster processing
  3. Batch your requests - For large volumes of data, consider using the non-waiting version (Add Agent Run) and poll for results

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

​
timeout
integer
default:60

How long to wait, in seconds, for the results from this Run.

Required range: 1 <= x <= 120

Body

multipart/form-data
​
files
file[]
required

List of files for the run. A single request can have a maximum of 300 files. Each file can have maximum size of 250MB.

​
user_defined_id
string | null

Optional user-defined identifier attached to this Run. Useful for tracking of Runs with external IDs.

Response

Successful Response

​
agent_id
integer
required

The ID of the Agent being run.

​
run_id
integer
required

The ID of this Agent Run.

​
user_defined_id
string | null
required

An optional user-defined ID attached to this Run.

​
created
string<date-time>
required

When this Run was created, formatted as an ISO 8601 timestamp (e.g. 2025-12-31T10:15:45+00:00)

​
updated
string<date-time>
required

When this Run was last updated, formatted as an ISO 8601 timestamp (e.g. 2025-12-31T10:15:45+00:00)

​
completed
string<date-time> | null
required

When all Prompts in this Run completed, formatted as an ISO 8601 timestamp (e.g. 2025-12-31T10:15:45+00:00).

The time between created and completed is the total time taken by the Agent for this Run. Will be null if the Run is still in progress and for historical Runs created before March 2026.

​
files
string[]
required

List of filenames included in this Run.

​
run_url
string
required

Link to this Run on agents.kolena.com.

​
order
string[]
required

The order of Prompts in this Agent. When results are ready for a Prompt, it will be included in the data object.

​
data
Data · object
required

The output data from completed Prompts, keyed on Prompt name.

Once a Prompt is completed (status success or failed), it will be included in this object. Any running prompts are omitted.

​
status
enum<string>
required

The status of this Run.

Available options:
running,
success,
failed
​
usage
AgentCreditUsage · object

For organizations with credit-based billing enabled, report the total credits used for this Run. null for organizations using page-based billing.