Skip to main content
Client Get Templated Output
curl --request POST \
  --url https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/runs/{run_id}/templated-output \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "output_template_id": 123,
  "output_format": "pdf"
}
'
"<string>"
Rate Limit: This endpoint is limited to 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
​
run_id
integer
required

Body

application/json
​
output_template_id
integer
required

The ID of the output template to use.

​
output_format
enum<string>
required

The format to download the templated output in. For Word templates, docx and pdf are allowed. For Excel templates, xlsx, xlsm, and csv are allowed. Note: csv will export the first worksheet of the Excel template only.

Available options:
pdf,
docx,
xlsx,
xlsm,
csv

Response

Returns the templated output file for download

The response is of type file.