a13nDocs
API referenceRuns

Read Run Item Content

Read one display field or follow its retained content reference, under the run's existing authorization.

GET/api/v1/runs/{run_id}/items/{item_id}/content

Read one display field or follow its retained content reference, under the run's existing authorization.

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

run_id*Run Id
item_id*Item Id

Query Parameters

ordinal*Ordinal

Ordinal returned with this item ID; both must match

Range1 <= value
field?Field
Default"all"

Value in

  • "all"
  • "text"
  • "arguments"
  • "result"
  • "value"
  • "result_parts"
  • "metadata"
  • "failure"
offset?Offset

Unicode code-point offset; continue with next_offset.

Range0 <= value
Default0
limit?Limit

Maximum Unicode code points in this fragment.

Range1 <= value <= 4000
Default4000
version?|

Content version from the first read; required after offset 0.

query?|

Case-sensitive literal text search.

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/runs/string/items/string/content?ordinal=1"
{  "has_more": true,  "match_offset": 0,  "media_type": "text/plain",  "next_offset": 0,  "offset": 0,  "query": "string",  "representation": "fragment",  "source": "string",  "source_truncated": false,  "text": "string",  "total_chars": 0,  "version": "string"}