{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/docs/ai/document-ai/getting-started/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Getting Started

\n

This guide walks through processing a document with a platform-managed configuration and reviewing the resulting data.

\n

Prerequisites

\n\n

Step 1: Choose a platform-managed configuration

\n

In Shipwell:

\n
    \n
  1. \nOpen \nDocument AI\n.\n
    2. \n
  2. \nSelect \nConfiguration\n.\n
    3. \n
  3. \nOpen \nProcessing Configuration\n.\n
    4. \n
  4. \nFind a configuration marked \nPlatform\n.\n
    5. \n
  5. \nOpen the configuration to review what it extracts and which processing features it enables.\n
    6. \n
\n

Platform-managed configurations are maintained by Shipwell and are read-only. See Platform-Managed Configurations.

\n

\"Platform-managed

\n

Step 2: Upload and process a document

\n
    \n
  1. \nReturn to the Document AI document list.\n
    2. \n
  2. \nSelect \nUpload documents\n.\n
    3. \n
  3. \nAdd your test document.\n
    4. \n
  4. \nIn \nUpload behavior\n, select the platform-managed configuration.\n
    5. \n
  5. \nReview the upload and submit it.\n
    6. \n
\n

Only enabled configurations appear in the upload selector.

\n\n

Step 3: Monitor processing

\n

After upload, the document appears in the document list. Processing is asynchronous, so the status changes as work progresses.

\n

Common statuses are:

\n\n

Open the document to view its latest processing status and progress.

\n\n

Step 4: Review the results

\n

When processing completes:

\n
    \n
  1. \nOpen the document.\n
    2. \n
  2. \nSelect its latest run.\n
    3. \n
  3. \nReview the summary and extracted schemas.\n
    4. \n
  4. \nSelect an extracted value to inspect its source when source regions are available.\n
    5. \n
\n

The exact result depends on the selected configuration. See Reading Results.

\n

API equivalent

\n

Upload one document with a known processing configuration:

\n\n
\n
\n curlpython\n
\n
\n
\n
" \\\\\n -F 'payload={\n "processing_config_id": "",\n "files": [{"filename": "sample-bol.pdf"}]\n }' \\\\\n -F "files=@sample-bol.pdf"`, `30123336918302736000`)\"\n >\n
Copy
\n
Copied
\n
\n 
curl -X POST "https://sandbox-api.shipwell.com/document-store/documents" \\\n  -H "Authorization: Token <user-token>" \\\n  -F 'payload={\n    "processing_config_id": "<processing-config-id>",\n    "files": [{"filename": "sample-bol.pdf"}]\n  }' \\\n  -F "files=@sample-bol.pdf"
\n
\n
"},\n data={\n "payload": json.dumps(\n {\n "processing_config_id": "",\n "files": [{"filename": "sample-bol.pdf"}],\n }\n )\n },\n files={"files": ("sample-bol.pdf", document_file, "application/pdf")},\n timeout=60,\n )\nresponse.raise_for_status()\ndocument = response.json()["documents"][0]`, `22133352605061620000`)\"\n >\n
Copy
\n
Copied
\n
\n 
import json\n\nimport requests\n\nwith open(\"sample-bol.pdf\", \"rb\") as document_file:\n    response = requests.post(\n        \"https://sandbox-api.shipwell.com/document-store/documents\",\n        headers={\"Authorization\": \"Token <user-token>\"},\n        data={\n            \"payload\": json.dumps(\n                {\n                    \"processing_config_id\": \"<processing-config-id>\",\n                    \"files\": [{\"filename\": \"sample-bol.pdf\"}],\n                }\n            )\n        },\n        files={\"files\": (\"sample-bol.pdf\", document_file, \"application/pdf\")},\n        timeout=60,\n    )\nresponse.raise_for_status()\ndocument = response.json()[\"documents\"][0]
\n
\n
\n \n

Use the returned document id to monitor processing or retrieve results.

\n

Next steps

\n","headings":[{"value":"Getting Started","depth":1},{"value":"Prerequisites","depth":2},{"value":"Step 1: Choose a platform-managed configuration","depth":2},{"value":"Step 2: Upload and process a document","depth":2},{"value":"Step 3: Monitor processing","depth":2},{"value":"Step 4: Review the results","depth":2},{"value":"API equivalent","depth":2},{"value":"Next steps","depth":2}]},"contentItem":{"data":{"lastModified":"2026-07-17T16:00:10.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"c9dcb260-5c66-50b0-8254-ced8edadd769__redocly content/docs/ai/document-ai/getting-started/","seo":{"title":"Getting Started","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/ai/document-ai/getting-started.md","pageBaseUrl":"/docs/ai/document-ai/getting-started","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Getting Started","id":"getting-started"},{"depth":2,"value":"Prerequisites","id":"prerequisites"},{"depth":2,"value":"Step 1: Choose a platform-managed configuration","id":"step-1-choose-a-platform-managed-configuration"},{"depth":2,"value":"Step 2: Upload and process a document","id":"step-2-upload-and-process-a-document"},{"depth":2,"value":"Step 3: Monitor processing","id":"step-3-monitor-processing"},{"depth":2,"value":"Step 4: Review the results","id":"step-4-review-the-results"},{"depth":2,"value":"API equivalent","id":"api-equivalent"},{"depth":2,"value":"Next steps","id":"next-steps"}]},"data":{"title":"Getting Started"},"catalogInfo":null,"link":"/docs/ai/document-ai/getting-started/","sidebarName":"developerPortal","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}