Skip to main content
Client Get Runs Templated Output
Rate Limit: This endpoint is limited to requests per minute per user.
The output always includes every Run on the Agent. Filtering to a subset of Runs is not currently supported.
Omit output_template_id to download all Runs as the default xlsx table, matching the Runs table export in the web app.

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

Body

application/json
output_template_id
integer | null

The ID of the multi-run Excel output template to use. The output format (xlsx or xlsm) matches the template file. When omitted, all runs are downloaded as the default xlsx table.

Response

Returns the templated output file, or the default xlsx table when no template is provided, containing all runs for download

The response is of type file.