Skip to main content
GET
/
v1
/
workflows
/
experiments
/
runs
/
{run_id}
/
results
/
{document_id}
from retab import Retab

client = Retab()

result = client.workflows.experiments.runs.results.get(
    "exprun_2",
    "expdoc_xyz",
)
print(result.lifecycle.status, result.artifact)
{
  "id": "expresult_1",
  "run_id": "exprun_2",
  "experiment_id": "exp_abc",
  "document_id": "expdoc_xyz",
  "block_kind": "extract",
  "lifecycle": { "status": "completed" },
  "timing": {
    "started_at": "2026-05-02T11:00:01Z",
    "completed_at": "2026-05-02T11:00:05Z",
    "duration_ms": 4120
  },
  "handle_inputs": {
    "input-document-0": { "type": "file", "filename": "invoice_q1.pdf" }
  },
  "artifact": { "operation": "extraction", "id": "ext_xyz" },
  "attempt": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.retab.com/llms.txt

Use this file to discover all available pages before exploring further.

Fetch one per-document result from an experiment run. The child key is document_id, not an internal job or result id.
from retab import Retab

client = Retab()

result = client.workflows.experiments.runs.results.get(
    "exprun_2",
    "expdoc_xyz",
)
print(result.lifecycle.status, result.artifact)
{
  "id": "expresult_1",
  "run_id": "exprun_2",
  "experiment_id": "exp_abc",
  "document_id": "expdoc_xyz",
  "block_kind": "extract",
  "lifecycle": { "status": "completed" },
  "timing": {
    "started_at": "2026-05-02T11:00:01Z",
    "completed_at": "2026-05-02T11:00:05Z",
    "duration_ms": 4120
  },
  "handle_inputs": {
    "input-document-0": { "type": "file", "filename": "invoice_q1.pdf" }
  },
  "artifact": { "operation": "extraction", "id": "ext_xyz" },
  "attempt": 0
}

Authorizations

Api-Key
string
header
required

Path Parameters

run_id
string
required
document_id
string
required

Response

Successful Response

Run-scoped per-document experiment result.

The storage row is still named experiment_jobs internally, but the public contract is a result row addressed by run_id + document_id.

id
string
required
run_id
string
required
experiment_id
string
required
document_id
string
required
lifecycle
ExperimentResultLifecycle · object
required
timing
ExperimentResultTiming · object
required
block_kind
enum<string>
required
Available options:
extract,
classifier,
split,
for_each
handle_inputs
Handle Inputs · object
artifact
StepArtifactRef · object

Canonical persisted resource produced by a workflow step.

Uniformly a (operation, id) ref into a backing collection. The artifact itself carries no payload — consumers dispatch on operation and fetch the backing record by id.

error
string | null
attempt
integer
default:0
is_placeholder
boolean
default:false