curl https://transform.unstructured.io/api/v2/parse \
-H "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
-F "input=@document.pdf"
{
"id": "9eb6c914-02a5-4c5d-8490-a06476946a38",
"status": "completed",
"profile": "balanced",
"warnings": [],
"markdown": "Invoice number: INV-1001",
"format_version": "2.0",
"metadata": {
"page_count": 1
},
"extracted_data": [],
"elements": [],
"source": {
"file_id": "invoice-9eb6c914.pdf",
"filename": "invoice.pdf",
"mimetype": "application/pdf",
"expires_at": "2026-09-18T18:34:26Z"
}
}Parse a document
Parse a document with the Transform API. Review the input field, output and profile options, and the Markdown or elements response schema.
curl https://transform.unstructured.io/api/v2/parse \
-H "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
-F "input=@document.pdf"
{
"id": "9eb6c914-02a5-4c5d-8490-a06476946a38",
"status": "completed",
"profile": "balanced",
"warnings": [],
"markdown": "Invoice number: INV-1001",
"format_version": "2.0",
"metadata": {
"page_count": 1
},
"extracted_data": [],
"elements": [],
"source": {
"file_id": "invoice-9eb6c914.pdf",
"filename": "invoice.pdf",
"mimetype": "application/pdf",
"expires_at": "2026-09-18T18:34:26Z"
}
}input. Authenticate with your API key. Output defaults to Markdown; profile and other controls are optional.
curl https://transform.unstructured.io/api/v2/parse \
-H "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
-F "input=@document.pdf"
Authorizations
API keys must be sent in this header.
Headers
Wait up to this many seconds for a completed parse. When omitted the request waits up to 15 minutes, then returns 202 with the job to poll.
Query Parameters
Optional list of projection fields to include in elements output. Allowed values are 'coordinates' and 'table_html'. Only valid when output='elements'.
Body
A document to parse, plus an optional schema to extract from it. Either input or file_id must be provided.
The document to parse. Required if file_id is not provided.
The ID of a previously uploaded file. Required if input is not provided.
The original filename to attach to the job when parsing a previously uploaded file.
Shape of the parsed output.
markdown, elements Optional JSON Schema, as a JSON string, describing fields to extract. Its presence switches parse-only to parse-then-extract.
1048576"{\"type\":\"object\",\"properties\":{\"invoice_number\":{\"type\":\"string\"}}}"
Optional free-text guidance that shapes how extracted fields are filled when schema is supplied. Limited to 1,048,576 bytes when encoded as UTF-8.
Optional customer-facing outcome profile. Omit it to use the current deployment default, balanced, or select one explicitly.
balanced, best Optional JSON object of advanced options. The only supported option is enrichments.image_description, a boolean that defaults to false.
4096"{\"enrichments\":{\"image_description\":true}}"
Response
The parse operation result, carrying the canonical document.
Parse operation metadata plus the canonical document, possibly before extraction has finished.
Underlying job id, for support and tracing.
Document processing or terminal status.
processing, completed, completed_with_warnings The effective profile used for raw-document partitioning.
balanced, best Rendered Markdown projection when requested; null when elements are requested.
The document envelope version.
2.0 Public document-level metadata.
Show child attributes
Show child attributes
Completed extraction results are available only after extraction has finished.
Show child attributes
Show child attributes
Public document elements.
Show child attributes
Show child attributes
The associated original uploaded source file, when known.
Show child attributes
Show child attributes
Notes about a result that still succeeded.
Show child attributes
Show child attributes
Was this page helpful?