{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-index.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API Quickstart","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"#cdcefb","fontSize":"14px","fontWeight":"700","textTransform":"uppercase","letterSpacing":"0.05em","display":"block","marginBottom":"-30px"}},"children":["Get Started"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-quickstart","__idx":0},"children":["API Quickstart"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Upload a document, create a parsing, and extract structured JSON with the Anesya API."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide walks through the fastest end-to-end Anesya workflow:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Upload a document"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Parse it"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Wait for processing to finish"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Extract structured data with a schema"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve the final JSON result"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By the end of this quickstart, you will have a complete document-to-JSON pipeline running with the public API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you only need to understand supported payloads first, continue with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/parsing"},"children":["Parsing"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/extract"},"children":["Extract"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-we-are-going-to-build","__idx":1},"children":["What we are going to build"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this quickstart, we will process one business document such as an invoice, form, or contract page."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The goal is to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["store the source document in Anesya"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["generate OCR and markdown content with a parsing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["apply one schema to the parsing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["receive a structured JSON result that can be used in your product, workflow, or LLM pipeline"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the most explicit and safest integration pattern because every step is visible and easy to debug."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-the-flow-works","__idx":2},"children":["How the flow works"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart LR\n A[Upload document] --> B[Create parsing]\n B --> C[Poll parsing]\n C --> D[Create extract]\n D --> E[Poll extract]\n E --> F[Use structured JSON]\n","diagramHtml":"

Upload document

Create parsing

Poll parsing

Create extract

Poll extract

Use structured JSON

","diagramHtmlDark":"

Upload document

Create parsing

Poll parsing

Create extract

Poll extract

Use structured JSON

"},"children":["flowchart LR\n A[Upload document] --> B[Create parsing]\n B --> C[Poll parsing]\n C --> D[Create extract]\n D --> E[Poll extract]\n E --> F[Use structured JSON]\n"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":3},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you start, make sure you have:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["an Anesya account"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["one API key"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["one schema ID"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["one local document file such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoice.pdf"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"1-create-an-api-key","__idx":4},"children":["1. Create an API key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create your API key from the Anesya dashboard, then keep it available for the next commands."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your docs deployment exposes it, you can also follow ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/api_key"},"children":["Create an API key"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"2-create-or-locate-a-schema","__idx":5},"children":["2. Create or locate a schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You need one schema ID for the extract step."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you still need to define your schema, use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/schemas/create_schema"},"children":["Create schema"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"3-export-convenient-shell-variables","__idx":6},"children":["3. Export convenient shell variables"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use environment variables to avoid repeating values in each command."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"macos--linux","__idx":7},"children":["macOS / Linux"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"export ANESYA_API_KEY=\"YOUR_API_KEY\"\nexport ANESYA_SCHEMA_ID=\"YOUR_SCHEMA_ID\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"windows-powershell","__idx":8},"children":["Windows PowerShell"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"powershell","header":{"controls":{"copy":{}}},"source":"$env:ANESYA_API_KEY=\"YOUR_API_KEY\"\n$env:ANESYA_SCHEMA_ID=\"YOUR_SCHEMA_ID\"\n","lang":"powershell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API calls below use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-API-Key"]}," header:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"X-API-Key: YOUR_API_KEY\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["curl"]}," commands below use bash-style environment variables such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$ANESYA_API_KEY"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you run them in PowerShell, replace:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$ANESYA_API_KEY"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$env:ANESYA_API_KEY"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$ANESYA_SCHEMA_ID"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["$env:ANESYA_SCHEMA_ID"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-upload-a-document","__idx":9},"children":["Step 1: Upload a document"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/schema/documents/document_create"},"children":["Create document"]}," to upload the source file and get a reusable document ID."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://api.anesya.app/v0/documents\" \\\n -H \"X-API-Key: $ANESYA_API_KEY\" \\\n -F \"file=@invoice.pdf;type=application/pdf\" \\\n -F \"filename=invoice.pdf\" \\\n -F 'metadata={\"source\":\"api-quickstart\"}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"id\": \"300f339f-da71-4f9f-80f6-c25a63baae75\",\n \"filename\": \"invoice.pdf\",\n \"file_url\": \"/v0/documents/300f339f-da71-4f9f-80f6-c25a63baae75/download\",\n \"metadata\": {\n \"source\": \"api-quickstart\"\n },\n \"page_count\": 3,\n \"created_at\": \"2025-06-12T14:56:10.682461Z\",\n \"updated_at\": \"2025-06-12T14:56:10.682461Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},". This is your document ID."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-create-a-parsing","__idx":10},"children":["Step 2: Create a parsing"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/schema/parsings/parsing_create"},"children":["Create parsing"]}," to generate OCR output, markdown content, page-level information, and optional picture descriptions."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://api.anesya.app/v0/parsing\" \\\n -H \"X-API-Key: $ANESYA_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"document\": \"300f339f-da71-4f9f-80f6-c25a63baae75\",\n \"picture_description_enabled\": false,\n \"table_verification_enabled\": false,\n \"model\": \"PIGALLE\",\n \"metadata\": {\n \"source\": \"api-quickstart\"\n }\n }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"id\": \"d1b96998-f20e-4b6f-8fa5-78a70b1db9b2\",\n \"document\": {\n \"id\": \"300f339f-da71-4f9f-80f6-c25a63baae75\",\n \"filename\": \"invoice.pdf\"\n },\n \"picture_description_enabled\": false,\n \"table_verification_enabled\": false,\n \"model\": \"PIGALLE\",\n \"status\": \"IN_QUEUE\",\n \"created_at\": \"2025-06-12T14:57:00.000000Z\",\n \"updated_at\": \"2025-06-12T14:57:00.000000Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the returned parsing ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At this stage, the parsing is created but not finished yet."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-poll-the-parsing-until-it-is-complete","__idx":11},"children":["Step 3: Poll the parsing until it is complete"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/schema/parsings/parsing_retrieve"},"children":["Retrieve parsing"]}," until the parsing reaches a final state."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.anesya.app/v0/parsing/d1b96998-f20e-4b6f-8fa5-78a70b1db9b2\" \\\n -H \"X-API-Key: $ANESYA_API_KEY\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The parsing is complete when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," becomes one of:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FINISHED"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PARTIAL_FINISHED"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ERROR"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example completed parsing response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"id\": \"d1b96998-f20e-4b6f-8fa5-78a70b1db9b2\",\n \"status\": \"FINISHED\",\n \"pages_total\": 3,\n \"pages_success\": 3,\n \"pages_failed\": 0,\n \"markdown_content\": \"# Invoice\\n\\nInvoice number: INV-2025-0042\\n\\nTotal: 1280.50 EUR\",\n \"ocr_content\": {\n \"pages\": []\n },\n \"pictures\": [],\n \"error\": null\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"what-to-inspect-in-the-parsing-response","__idx":12},"children":["What to inspect in the parsing response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These fields are usually the most useful:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},": current processing state"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["markdown_content"]},": extracted readable markdown"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ocr_content"]},": structured OCR payload"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pages_total"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pages_success"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pages_failed"]},": page-level outcome"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]},": failure reason when the parsing fails"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the status is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PARTIAL_FINISHED"]},", the parsing can still be usable. Some pages failed, but successful pages are available."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a full polling strategy, read ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/parsing"},"children":["Parsing"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/extract"},"children":["Extract"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4-create-an-extract-from-the-parsing","__idx":13},"children":["Step 4: Create an extract from the parsing"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once the parsing is usable, call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/schema/extracts/extract_create"},"children":["Create extract"]}," with the parsing ID and your schema ID."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://api.anesya.app/v0/extract\" \\\n -H \"X-API-Key: $ANESYA_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d \"{\n \\\"parsing\\\": \\\"d1b96998-f20e-4b6f-8fa5-78a70b1db9b2\\\",\n \\\"schema\\\": \\\"$ANESYA_SCHEMA_ID\\\"\n }\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"id\": \"e90f337f-4d7c-46d1-a2a7-13cf5d9d7cfe\",\n \"schema\": {\n \"id\": \"YOUR_SCHEMA_ID\",\n \"name\": \"Invoice schema\",\n \"description\": \"Schema used for extracting data from invoices.\",\n \"completion_mode\": \"CLASSIC\"\n },\n \"parsing\": {\n \"id\": \"d1b96998-f20e-4b6f-8fa5-78a70b1db9b2\"\n },\n \"result\": null,\n \"status\": \"IN_QUEUE\",\n \"error\": null,\n \"created_at\": \"2025-06-12T14:58:00.000000Z\",\n \"updated_at\": \"2025-06-12T14:58:00.000000Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the returned extract ID."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-5-poll-the-extract-until-the-json-result-is-ready","__idx":14},"children":["Step 5: Poll the extract until the JSON result is ready"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/schema/extracts/extract_retrieve"},"children":["Retrieve extract"]}," until the extract reaches a final state."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.anesya.app/v0/extract/e90f337f-4d7c-46d1-a2a7-13cf5d9d7cfe\" \\\n -H \"X-API-Key: $ANESYA_API_KEY\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The extract is complete when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," becomes one of:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FINISHED"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ERROR"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When the status is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FINISHED"]},", the structured output is available in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["result"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example final response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"id\": \"e90f337f-4d7c-46d1-a2a7-13cf5d9d7cfe\",\n \"status\": \"FINISHED\",\n \"result\": {\n \"invoice_number\": \"INV-2025-0042\",\n \"invoice_date\": \"2025-06-01\",\n \"total_amount\": 1280.5\n },\n \"error\": null\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At this point, you can send the JSON result to your application, automation platform, or LLM workflow."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"understanding-what-you-got-back","__idx":15},"children":["Understanding what you got back"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After this quickstart, you have created three useful resources:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it gives you"},"children":["What it gives you"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Document"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A reusable uploaded source file"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Parsing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OCR, markdown, page-level processing data, and status tracking"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Extract"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Structured JSON generated from one schema"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This separation is useful because it lets you:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["inspect the parsing before extraction"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["reuse the same document later"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["reuse the same parsing in downstream logic"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["debug failures more easily than a single opaque request"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-variations","__idx":16},"children":["Common variations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The flow above is the safest default, but you can simplify it depending on your use case."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"skip-document-upload","__idx":17},"children":["Skip document upload"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your file is already available elsewhere, you can create a parsing directly from:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["one document ID"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["one public URL"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["one uploaded file"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a list of public URLs"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/parsing"},"children":["Parsing"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"skip-the-explicit-parsing-step","__idx":18},"children":["Skip the explicit parsing step"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you only need one final extract and do not need OCR or markdown separately, you can call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/schema/extracts/extract_create"},"children":["Create extract"]}," directly with:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["one document ID"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["one public URL"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["one uploaded file"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/extract"},"children":["Extract"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"troubleshooting","__idx":19},"children":["Troubleshooting"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"401-unauthorized","__idx":20},"children":["401 Unauthorized"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your API key is missing or invalid. Check the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-API-Key"]}," header and confirm that the key is active."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parsing-stays-in-in_queue-or-in_progress","__idx":21},"children":["Parsing stays in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN_QUEUE"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN_PROGRESS"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Keep polling. Parsing and extract jobs are asynchronous by design."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parsing-ends-in-partial_finished","__idx":22},"children":["Parsing ends in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PARTIAL_FINISHED"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Inspect ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pages_failed"]}," and decide whether partial output is acceptable for your workflow."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"extract-ends-in-error","__idx":23},"children":["Extract ends in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ERROR"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Check the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," field, confirm that the parsing is already finished, and verify that the schema ID is valid."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-to-read-next","__idx":24},"children":["What to read next"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After this quickstart, the most useful next pages are:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/parsing"},"children":["Parsing"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/extract"},"children":["Extract"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/parsing"},"children":["Parsing and extract status handling"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/n8n/n8n-parsing"},"children":["n8n parsing workflow"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/tutorials/agent-guide"},"children":["AI agent integration guide"]}]}]}]},"headings":[{"value":"API Quickstart","id":"api-quickstart","depth":1},{"value":"What we are going to build","id":"what-we-are-going-to-build","depth":2},{"value":"How the flow works","id":"how-the-flow-works","depth":2},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"1. Create an API key","id":"1-create-an-api-key","depth":3},{"value":"2. Create or locate a schema","id":"2-create-or-locate-a-schema","depth":3},{"value":"3. Export convenient shell variables","id":"3-export-convenient-shell-variables","depth":3},{"value":"macOS / Linux","id":"macos--linux","depth":4},{"value":"Windows PowerShell","id":"windows-powershell","depth":4},{"value":"Step 1: Upload a document","id":"step-1-upload-a-document","depth":2},{"value":"Step 2: Create a parsing","id":"step-2-create-a-parsing","depth":2},{"value":"Step 3: Poll the parsing until it is complete","id":"step-3-poll-the-parsing-until-it-is-complete","depth":2},{"value":"What to inspect in the parsing response","id":"what-to-inspect-in-the-parsing-response","depth":3},{"value":"Step 4: Create an extract from the parsing","id":"step-4-create-an-extract-from-the-parsing","depth":2},{"value":"Step 5: Poll the extract until the JSON result is ready","id":"step-5-poll-the-extract-until-the-json-result-is-ready","depth":2},{"value":"Understanding what you got back","id":"understanding-what-you-got-back","depth":2},{"value":"Common variations","id":"common-variations","depth":2},{"value":"Skip document upload","id":"skip-document-upload","depth":3},{"value":"Skip the explicit parsing step","id":"skip-the-explicit-parsing-step","depth":3},{"value":"Troubleshooting","id":"troubleshooting","depth":2},{"value":"401 Unauthorized","id":"401-unauthorized","depth":3},{"value":"Parsing stays in IN_QUEUE or IN_PROGRESS","id":"parsing-stays-in-in_queue-or-in_progress","depth":3},{"value":"Parsing ends in PARTIAL_FINISHED","id":"parsing-ends-in-partial_finished","depth":3},{"value":"Extract ends in ERROR","id":"extract-ends-in-error","depth":3},{"value":"What to read next","id":"what-to-read-next","depth":2}],"frontmatter":{"seo":{"title":"API Quickstart"}},"lastModified":"2026-04-22T15:07:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/tutorials/quickstart","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}