TrueParser accepts document ingestion through a high-performance HTTP API. The ingestion process is designed for streaming request bodies and optional presigned upload sessions for larger files.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.
Submission Flow
The primary endpoint for document ingestion isPOST /api/v1/documents/upload.
Ingestion Contract
- Authentication: Requires a valid JWT access token issued by the Dashboard.
- Payload: Accepts the raw document stream in the HTTP request body.
- Identification: You can optionally supply a
documentType(e.g.,PDF,DWG,SHP_ZIP). If omitted, TrueParser will attempt to detect the format automatically.
Explicit Routing Requirements
Some technical formats require explicit hints to ensure accurate parsing:- SQL: Requires a
sqlDialect(e.g.,PostgreSQL,Snowflake). - CSV: Requires a
csvRoute(SpatialorTabular) to disambiguate routing. - PDF: Requires a
pdfMode(SingleColumn,MultiColumn,Ocr,Advanced). - Parquet: Supports optional
parquetMode(MetadataOnly,MetadataPlusRows). If omitted,MetadataOnlyis used.
Identification & Metadata
Document Identifiers
You can provide your owndocumentId at submission time to maintain consistency with your internal systems. If you don’t provide one, TrueParser will automatically generate a unique GUID for the job.
[!NOTE]
documentId uniqueness is enforced only within the active 3-hour retention window.
Custom Metadata
The ingestion API allows you to attach custom metadata JSON to any job. This metadata is carried through the pipeline and included in the final parsed output, providing traceability for your downstream applications.Performance Considerations
TrueParser is optimized for high-volume ingestion. To achieve maximum throughput:- Streaming Ingestion: Pass raw streams directly to the API where possible.
- Zero-Disk Buffering: The engine processes data from memory to storage, avoiding expensive disk I/O operations on the system.
- Rate Limiting: Ingestion is subject to your plan’s concurrency and byte limits. Check your Usage in the dashboard for current thresholds.
Upload Size Paths
TrueParser supports two ingestion paths:- Direct upload:
POST /api/v1/documents/uploadfor raw-body uploads (up to direct-upload limit). - Presigned upload:
POST /api/v1/documents/upload-requestthenPOST /api/v1/documents/upload-completefor larger files.