Skip to main content
GET
/
v0
/
batches
/
{id}
/
results
Get Results
curl --request GET \
  --url https://api.example.com/v0/batches/{id}/results \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "data": {
    "data": [
      {
        "data_uuid": "<string>"
      }
    ]
  },
  "message": "<string>",
  "error": {
    "code": 123,
    "details": "<string>"
  },
  "file": {
    "file": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Batch 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

Successfully retrieved batch results

​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
data
object
required
​
message
string
required
​
error
object
​
file
object