Skip to main content
GET
Agent Result Check

Authorizations

X-API-Key
string
header
required

Path Parameters

request_id
string
required

Cookies

wos-session
string
datalab_active_team
string

Response

Successful Response

Response model for the /agent endpoint.

status
string
required

The status of the request. Should be 'complete' when the request is done.

result_url
string | null

Signed URL for downloading the completed result JSON when direct result download is required.

expires_in
integer | null

Number of seconds until result_url expires.

success
boolean | null

Whether the agent run succeeded.

error
string | null

If the run was not successful, this will contain an error message.

output_shape
string | null

The output shape requested for this run: 'parse', 'json', 'wcag', 'jats', or 'segment'.

finished
boolean | null

Whether the agent finished its task before hitting max_turns.

turns
integer | null

The number of turns the agent took.

markdown
string | null

The markdown output of the run, when applicable.

html
string | null

The HTML output of the run, when applicable.

json

The structured JSON output of the run, when applicable.

chunks

The output in chunks format, when applicable.

extraction_schema_json

The filled-in extraction schema, when applicable.

segments
Segments · object[] | null

Segment records for the 'segment' output shape (production /segment sense): {name, pages (0-indexed), confidence}.

metadata
Metadata · object | null

A dictionary of metadata about the document and the run.

verdict
string | null

The agent's final verdict for generic output shapes, when applicable.

jats_xml
string | null

The JATS 1.2 Journal-Publishing article XML, for the 'jats' output shape.

accessible_pdf
string | null

The tagged, accessible PDF (PDF/UA-1) as a base64 string, for the 'wcag' output shape.

images
Images · object | null

Images produced by the run as base64 strings, keyed by the name the output references them by. Only populated when return_images was set on the request.

verifier_metrics
Verifier Metrics · object[] | null

Verification results emitted as metrics (not a gate).

page_count
integer | null

The number of pages that were processed.

total_cost
integer | null
deprecated

The total cost of the run.

cost_breakdown
Cost Breakdown · object | null

A dictionary of the cost breakdown of this request.

parse_quality_score
number | null

The parse quality score of the output, if available.

runtime
number | null

The runtime of the run.

versions

A dictionary of the versions of the libraries used in the request.