---
title: "Read Text"
method: POST
path: "/extensions/roboledger/{graph_id}/operations/read-text"
tags: ["RoboLedger: Analytical Views"]
---

# Read Text

`POST /extensions/roboledger/{graph_id}/operations/read-text`

## Request

- Base URL: `https://api.robosystems.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/read-text`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

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.

## Path parameters

- `graph_id` string, required

## Headers

- `Idempotency-Key` string, nullable

## Request body

- ReadTextRequest: Request for the read-text view op — a window of one filing's text.
  - `ticker` string, nullable: 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` string, nullable: Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.
  - `fiscal_year` integer, nullable: Narrow auto-resolution to this fiscal year focus
  - `period_type` string, nullable: Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)
  - `accession` string, nullable: SEC only, with ticker: one filing by accession number — a report, or an 8-K from resolved_report.recent_releases
  - `form` string, nullable: SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
  - `offset` integer: Character offset to start from
  - `length` integer, nullable: Characters to return (default 4000)

## Response `200`

Successful Response

- OperationEnvelopeReadTextResponse
  - `operation` string, required: Kebab-case operation name
  - `operationId` string, required: op_-prefixed ULID for audit and SSE correlation
  - `status` 'completed' | 'pending' | 'failed', required: Operation lifecycle state
  - `result` ReadTextResponse: The read-text view op's result: one window of the filing's text.
    - `graph_id` string, required
    - `report_id` string, nullable
    - `accession` string, nullable
    - `resolved_report` object, nullable
    - `offset` integer, required
    - `length` integer, required
    - `text` string, required
    - `text_chars` integer, required
    - `next_offset` integer, nullable
    - `section` string, nullable
  - `at` string, required: ISO-8601 UTC timestamp
  - `createdBy` string, nullable: User ID that initiated the operation
  - `idempotentReplay` boolean: True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

## Other responses

- `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

---

[API](https://skmtc.dev/robosystems/apis/robosystems-api.md) · [All operations](https://skmtc.dev/robosystems/apis/robosystems-api/llms.txt) · [OpenAPI document](https://skmtc.dev/robosystems/apis/robosystems-api/revisions/e661e2d5ca6a?raw)