RoboLedger: Analytical Views

Describe Filing

How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset read-text pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a ticker picks it: the latest annual report, narrowed by fiscal_year / period_type, or one accession, or with form: 8-K the latest earnings release and its exhibits (fiscal_year is then the calendar year it was filed, and a CIK may stand in for the ticker). SEC only: a ledger files no document, and its sections read through disclosures and information-block.

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.

post/extensions/roboledger/{graph_id}/operations/describe-filing

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/describe-filing
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Headers

Idempotency-Keystring nullable

Request body

tickerstring 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_idstring nullable

Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.

fiscal_yearinteger nullable

Narrow auto-resolution to this fiscal year focus

period_typestring nullable

Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)

accessionstring nullable

SEC only, with ticker: one filing by accession number — a report, or an 8-K from resolved_report.recent_releases

formstring nullable

SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year

Response

Successful Response

operationstring required

Kebab-case operation name

operationIdstring required

op_-prefixed ULID for audit and SSE correlation

status'completed' | 'pending' | 'failed' required

Operation lifecycle state

atstring required

ISO-8601 UTC timestamp

createdBystring nullable

User ID that initiated the operation

idempotentReplayboolean

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

Changes

No recorded changes to this operation across all 1 revision of this API.