---
title: "Describe Filing"
method: POST
path: "/extensions/roboledger/{graph_id}/operations/describe-filing"
tags: ["RoboLedger: Analytical Views"]
---

# Describe Filing

`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

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.

## Path parameters

- `graph_id` string, required

## Headers

- `Idempotency-Key` string, nullable

## Request body

- DescribeFilingRequest: Request for the describe-filing view op — how a filing is laid out.
  - `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

## Response `200`

Successful Response

- OperationEnvelopeDescribeFilingResponse
  - `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` DescribeFilingResponse: The describe-filing view op's result: xbrlkit's layout of the filing.
    - `graph_id` string, required
    - `report_id` string, nullable
    - `accession` string, nullable
    - `resolved_report` object, nullable
    - `profile` object, nullable
    - `filing` object, nullable
    - `entity` object, nullable
    - `counts` object, nullable
    - `sections` object, 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)