Skip to main content
POST
/
api
/
v1
/
client
/
agents
/
{agent_id}
/
runs
/
wait
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 'user_defined_id=<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",
  "files": [
    "<string>"
  ],
  "run_url": "<string>",
  "order": [
    "<string>"
  ],
  "data": {},
  "status": "running",
  "usage": {
    "credits_used": 123
  }
}

​
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.

​
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 150 files. Each file can have maximum 125MB.

​
user_defined_id
string | null

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-11-13T15:53:59.655033+00:00)

​
updated
string<date-time>
required

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

​
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.