Read Text

post/extensions/roboledger/{graph_id}/operations/read-text

One window of a filing's whole text from a character offset — a search-text hit's, or a section's from describe-filing — with next_offset while more follows. Same filing selection as describe-filing.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

Authentication

Authenticate in any one of these ways — not all of them:

API key in the X-API-Key header.
Bearer token in the Authorization header.

Path parameters

Name	Type	Description
`graph_id`required	string	Graph Id

Header parameters

Name	Type	Description
`Idempotency-Key`optional	string	Idempotency-Key

Request body

Required, application/json.

Field	Type	Description
`ticker`optional	string	Company ticker. On shared-repository graphs (SEC) it resolves the latest matching filing when report_id is not given; ignored on tenant graphs.
`report_id`optional	string	Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.
`fiscal_year`optional	integer	Narrow auto-resolution to this fiscal year focus
`period_type`optional	string	Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)
`accession`optional	string	SEC only, with ticker: one filing by accession number — a report, or an 8-K from resolved_report.recent_releases
`form`optional	string	SEC only, with ticker: '8-K' reads the latest earnings release
`offset`optional	integer	Character offset to start from Default: `0` Constraints: at least 0
`length`optional	integer	Characters to return (default 4000) Constraints: 1–8000

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/read-text" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "ticker": "string",
  "report_id": "string",
  "fiscal_year": 0,
  "period_type": "string",
  "accession": "string",
  "form": "string",
  "offset": 0,
  "length": 0
}'

Responses

200 Successful Response

Field Type Description

operationrequired

string

Kebab-case operation name

operationIdrequired

string

op_-prefixed ULID for audit and SSE correlation

statusrequired

string

Operation lifecycle state

One of: completed, pending, failed

resultoptional

ReadTextResponse

Command-specific result payload

ReadTextResponse fields

Field	Type	Description
`graph_id`required	string
`report_id`optional	string
`accession`optional	string
`resolved_report`optional	object
`offset`required	integer
`length`required	integer
`text`required	string
`text_chars`required	integer
`next_offset`optional	integer
`section`optional	string

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

User ID that initiated the operation

idempotentReplayoptional

boolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Default: false

Status	Meaning
400	Invalid request
401	Authentication required
403	Access denied
404	Resource not found
409	Idempotency-Key conflict — key reused with different body
422	Validation error
429	Rate limit exceeded
500	Internal server error