Once a document is ingested, it moves through the async parsing process. To retrieve the result, your application follows a standard Polling and Retrieval pattern.Documentation Index
Fetch the complete documentation index at: https://docs.trueparser.com/llms.txt
Use this file to discover all available pages before exploring further.
Status Polling
You can check the progress of a parse job using theGET /api/v1/documents/{documentId}/status endpoint.
The status response includes the current lifecycle state:
queued: The job is waiting to be processed.processing: The engine is actively parsing the document.materializing: Structured output is being finalized.waiting-for-provider/provider-processing: External-provider-backed extraction is in progress.completed: The result has been materialized and is ready for download.failed: An error occurred during extraction.
Retrieving Results
The final, materialized artifact is retrieved viaGET /api/v1/documents/{documentId}/result.
Retrieval Flow
- Submit: Documents are accepted and queued for processing via the ingestion endpoint.
- Poll: Your application polls the status endpoint until the state reaches completed.
- Fetch: Call the result endpoint to receive the final structured data.
Platform Boundary
To ensure security and stability, TrueParser proxies all result access. Your application interacts only with the platform’s REST endpoints and never connects directly to the underlying S3-compatible storage. This allows us to manage per-request authorization and regional routing transparently.Output Formats
TrueParser delivers the final parsed result as canonical JSON. That is the primary product-facing artifact returned through the API.1. JSON Document (Primary)
The standard and recommended format for most applications. TrueParser materializes the parsed data into a final, valid JSON artifact.- Best For: Web applications, mobile clients, and standard data processing pipelines.
Schema Versioning
Every result artifact includes aschema_version and document_format marker. These contracts are stable within a major version, ensuring your downstream logic remains robust even as underlying parser engines are updated.