Batches
Get Results
Get batch execution results once a batch reaches COMPLETED status. Receive the raw output or data to download depending on flag selection.
GET
/
v0
/
batches
/
{id}
/
results
Authorizations
x-api-key
string
headerrequiredPath Parameters
id
string
requiredBatch ID to retrieve results from
Query Parameters
output_type
enum<string>
Output type (raw, stream, webhook) - default raw
Available options:
raw
, stream
, webhook
webhook_url
string
Webhook URL to send data to (if output_type "webhook" is selected. If not set and webhook is selected, it will default to the existing webhook associated with the batch if one exists.
Response
200 - application/json
status
enum<string>
requiredAvailable options:
success
, error
data
object
requiredmessage
string
requirederror
object
file
object