Skip to main content
GET
Rate limit tier: general, 600 requests/min. See Rate limits. Reads the ground truth a dataset document packet holds: the expected value of every field, keyed by the field’s persistent_id, as an eval grades it. Read it before you correct it with Set ground truth. document_packet_id is the dataset copy’s id: the one Upload to dataset returns, or the one GET …/evals/{eval_id}/accuracy/ lists in by_document_packet. Omit version to read the workflow’s current version, the one an eval grades by default; pass a version_id from List workflow versions to read another. node_id is the extract node’s id in the workflow graph, and you need it only when the version has more than one extract node; without it such a version answers 422 EXTRACT_NODE_UNRESOLVED. The response names the version_id and node_id it was read from. ground_truth is null until ground truth is first set for that version and node. Any key with the read scope can read. Every 404 NOT_FOUND names what is missing in params.resource_type: document_packet for an unknown packet or one in another organization, and workflow_version for an unknown version. A production packet answers 409 NOT_IN_DATASET: only a dataset document packet holds ground truth.

Authorizations

Authorization
string
header
required

API key issued from app.anyformat.ai/api-key. Send as Authorization: Bearer <key>.

Path Parameters

document_packet_id
string
required

Query Parameters

version
string | null

A version_id from GET /v3/workflows/{workflow_id}/versions/. Omit it for the workflow's current version, the one an eval grades by default.

node_id
string | null

The extract node's id in the workflow graph, as GET /v3/workflows/{workflow_id}/ returns it. Required only when the version has more than one extract node.

Response

Successful Response

A document packet's stored ground truth and the (version, node) it belongs to.

ground_truth
Ground Truth · object | null
required

The expected document, keyed by the workflow's field persistent_ids. A scalar field maps to string | null; a table or object field maps to an array of row objects keyed the same way. null until ground truth is first set for this version and node.

Example:
version_id
string
required

The workflow version the ground truth belongs to.

Example:

"FGaV4I2JAA"

node_id
string
required

The extract node's id in the workflow graph.

Example:

"extract_1"