Browse documentation
Documents

Submit a Document

Submit freight PDFs through Manifest AI API v1 with field mappings, duplicate protection, credits, and idempotency.

POST a PDF to /api/v1/documents as multipart form data. Idempotency-Key is required in V7, and each accepted page uses one workspace page credit.

Request

The PDF is required; layout information is optional when auto-detection is appropriate.

file
Required PDF. Maximum 50 MB and 300 pages, subject to plan and workspace limits.
profile_id
Optional saved layout profile identifier from GET /api/v1/profiles.
vendor_name
Optional human-readable layout or vendor label.
schema_definition
Optional JSON field definition when no saved profile is used.
allow_duplicate
Set true only when an identical file is intentionally new work.
cURL
curl -X POST "https://manifestai.io/api/v1/documents" \
  -H "Authorization: Bearer $MANIFEST_AI_API_KEY" \
  -H "Idempotency-Key: shipment-1042-commercial-invoice" \
  -F "file=@commercial-invoice.pdf" \
  -F "profile_id=YOUR_PROFILE_ID"

Accepted response

A new job returns HTTP 202 and a document resource with status and links.

An idempotent retry returns the original document without creating another charge. A conflicting payload under the same idempotency key returns HTTP 409.

Credits and validation

Validation occurs before durable processing begins.

  • Malformed, non-PDF, oversized, or over-limit files are rejected.
  • The workspace must have enough available page credits.
  • Credits are reserved atomically to avoid concurrent overspending.
  • Unused work is returned if processing cannot complete.