Get batch results

Authentication#

Authorizationheaderrequired

Bearer dn_live_..., the same key as every call. A batch belongs to the key that created it: other keys, even in the same workspace, get 404 for it.

Path parameters#

idstringrequired

The batch id that Create a batch returned, for example batch_01J9ZB8Q3T.

Query parameters#

format"json"

Leave it out for the whole file as JSON Lines. json returns one page of lines as a JSON object.

offsetintegerdefault 0

With format=json: the first line of the page, counted from 0 in upload order.

limitintegerdefault 1,000

With format=json: lines per page, 1 to 1,000.

For a small batch, or to read a large one a page at a time, ask for format=json and follow next_offset:

API=https://api.decisionnode.com/v1
BATCH=batch_01J9ZB8Q3T

# one page; ask again with offset set to the page's next_offset until it is null
curl -G "$API/batches/$BATCH/results" \
  -H "Authorization: Bearer $DECISIONNODE_API_KEY" \
  -d format=json -d offset=0 -d limit=1000

Response#

Without format: 200 OK, Content-Type: application/x-ndjson, one line per request in upload order. With format=json: a page object.

{"custom_id":"ticket-48213","status":200,"body":{"model":"decisionnode-1.0","answers":{"route":{"type":"choice","choice":"billing","confidence":0.81,"probabilities":{"account":0.05,"billing":0.87,"bug":0.08}},"refund":{"type":"truth","truth":0.94}},"usage":{"input_tokens":47,"output_tokens":0}},"headers":{"x-request-id":"req_01J9ZE1A4K","x-decisionnode-model":"decisionnode-1.0","x-decisionnode-safety":"harm=0.002, self_harm=0.001"}}
{"custom_id":"ticket-48214","status":200,"body":{"model":"decisionnode-1.0","answers":{"route":{"type":"choice","choice":"bug","confidence":0.9,"probabilities":{"account":0.03,"billing":0.04,"bug":0.93}},"refund":{"type":"truth","truth":0.02}},"usage":{"input_tokens":45,"output_tokens":0}},"headers":{"x-request-id":"req_01J9ZE1A5M","x-decisionnode-model":"decisionnode-1.0","x-decisionnode-safety":"harm=0.001, self_harm=0.001"}}
{"custom_id":"ticket-48215","status":200,"body":{"model":"decisionnode-1.0","answers":{"route":{"type":"choice","choice":"account","confidence":0.84,"probabilities":{"account":0.89,"billing":0.06,"bug":0.05}},"refund":{"type":"truth","truth":0.03}},"usage":{"input_tokens":46,"output_tokens":0}},"headers":{"x-request-id":"req_01J9ZE1A6P","x-decisionnode-model":"decisionnode-1.0","x-decisionnode-safety":"harm=0.001, self_harm=0.002"}}

A result line#

{
  "custom_id": "ticket-48213",
  "status": 200,
  "body": {
    "model": "decisionnode-1.0",
    "answers": {
      "route": {
        "type": "choice",
        "choice": "billing",
        "confidence": 0.81,
        "probabilities": { "account": 0.05, "billing": 0.87, "bug": 0.08 }
      },
      "refund": { "type": "truth", "truth": 0.94 }
    },
    "usage": { "input_tokens": 47, "output_tokens": 0 }
  },
  "headers": {
    "x-request-id": "req_01J9ZE1A4K",
    "x-decisionnode-model": "decisionnode-1.0",
    "x-decisionnode-safety": "harm=0.002, self_harm=0.001"
  }
}

custom_idstring

The id you gave the request.

statusinteger | "expired" | "cancelled"

The HTTP status the live call returned (200 for answers, or the error status), or "expired" or "cancelled" for a request that never ran.

bodyobject | null

The live response body: model, answers and usage for a 200, the live error body (detail) otherwise. null for a request that never ran.

headersobject

What the live call sends as response headers, since a file has none. Empty for a request that never ran or was refused when uploaded.

x-request-idstring

The request id. Quote it when you contact us.

x-decisionnode-modelstring

The pinned model version that answered.

x-decisionnode-safetystring

The safety check's probability per category, as on every live response.

x-decisionnode-image-tokensstring

The part of usage.input_tokens that came from images, on lines with images.

x-decisionnode-refusalstring

On a 403: the category the safety check refused.

x-decisionnode-billable-tokensstring

On a 403: the tokens the refusal bills, 0 today.

x-decisionnode-errorstring

On an error: what went wrong, in words.

Lines that did not return answers#

{
  "custom_id": "ticket-48216",
  "status": 400,
  "body": {
    "detail": {
      "error_type": "api_usage_error",
      "message": "Unknown model: decisionode-latest"
    }
  },
  "headers": {}
}

format=json

resultsarray

The lines of this page, each as above.

offsetinteger

The offset you asked for.

limitinteger

The limit you asked for.

totalinteger

Lines in the whole file: the batch's counters.requests.

next_offsetinteger | null

The offset of the next page, or null on the last one.