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

Runs and Reprocessing

\n

Create a processing run during upload or apply a new configuration to a document that is already stored.

\n

Start processing during upload

\n

Provide either:

\n\n

The accepted document includes latest_run with the new run identifier and initial pending status.

\n

Omit both fields when the file should be stored without processing. See Uploading Documents for multipart, base64, and direct upload examples.

\n

Process existing documents in Shipwell

\n
    \n
  1. \nOpen \nDocument AI\n.\n
    2. \n
  2. \nSelect one or more stored documents.\n
    3. \n
  3. \nChoose the processing action.\n
    4. \n
  4. \nSelect an enabled named configuration or custom processing settings.\n
    5. \n
  5. \nConfirm the request.\n
    6. \n
\n\n\n

Process existing documents through the API

\n

Create one new run for each accepted document:

\n\n
\n
\n curlpython\n
\n
\n
\n
" \\\\\n -H "Content-Type: application/json" \\\\\n -d '{\n "document_ids": [\n "",\n ""\n ],\n "processing_config_id": ""\n }'`, `45136483792004700000`)\"\n >\n
Copy
\n
Copied
\n
\n 
curl -X POST "https://sandbox-api.shipwell.com/document-store/runs" \\\n  -H "Authorization: Token <user-token>" \\\n  -H "Content-Type: application/json" \\\n  -d '{\n    "document_ids": [\n      "<document-id-1>",\n      "<document-id-2>"\n    ],\n    "processing_config_id": "<processing-config-id>"\n  }'
\n
\n
"},\n json={\n "document_ids": ["", ""],\n "processing_config_id": "",\n },\n timeout=30,\n)\nresponse.raise_for_status()\nresult = response.json()`, `60724230777578955000`)\"\n >\n
Copy
\n
Copied
\n
\n 
import requests\n\nresponse = requests.post(\n    \"https://sandbox-api.shipwell.com/document-store/runs\",\n    headers={\"Authorization\": \"Token <user-token>\"},\n    json={\n        \"document_ids\": [\"<document-id-1>\", \"<document-id-2>\"],\n        \"processing_config_id\": \"<processing-config-id>\",\n    },\n    timeout=30,\n)\nresponse.raise_for_status()\nresult = response.json()
\n
\n
\n \n

Exactly one of processing_config_id or pipeline_config is required. Document identifiers must be unique within the request.

\n

The endpoint returns 202 Accepted:

\n
\n
",\n "id": ""\n }\n ],\n "skipped": [\n {\n "document_id": "",\n "decision": "skipped",\n "reason": ""\n }\n ]\n}`, `78711487421371470000`)\"\n >\n
Copy
\n
Copied
\n
\n 
{\n  \"runs\": [\n    {\n      \"document_id\": \"<document-id-1>\",\n      \"id\": \"<run-id>\"\n    }\n  ],\n  \"skipped\": [\n    {\n      \"document_id\": \"<document-id-2>\",\n      \"decision\": \"skipped\",\n      \"reason\": \"<eligibility-reason>\"\n    }\n  ]\n}
\n
\n

Keep every returned run id for monitoring. A skipped document does not receive a run.

\n

View run history

\n

Use GET /document-store/documents/{id}/runs to retrieve a document's runs, newest first.

\n

Use run history to:

\n\n\n

Reprocessing behavior

\n

Reprocessing creates a new run; it does not replace prior runs.

\n

If the new run completes:

\n\n

Store the relevant run_id when your integration requires historical reproducibility.

\n

When to reprocess

\n

Create a new run when:

\n\n

Do not create duplicate runs only because an accepted run is still pending or processing. Monitor it using How Processing Works.

","headings":[{"value":"Runs and Reprocessing","depth":1},{"value":"Start processing during upload","depth":2},{"value":"Process existing documents in Shipwell","depth":2},{"value":"Process existing documents through the API","depth":2},{"value":"View run history","depth":2},{"value":"Reprocessing behavior","depth":2},{"value":"When to reprocess","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":"7b106edb-09b0-5dde-8681-248ceb2a7c05__redocly content/docs/ai/document-ai/runs-and-reprocessing/","seo":{"title":"Runs and Reprocessing","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/ai/document-ai/runs-and-reprocessing.md","pageBaseUrl":"/docs/ai/document-ai/runs-and-reprocessing","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Runs and Reprocessing","id":"runs-and-reprocessing"},{"depth":2,"value":"Start processing during upload","id":"start-processing-during-upload"},{"depth":2,"value":"Process existing documents in Shipwell","id":"process-existing-documents-in-shipwell"},{"depth":2,"value":"Process existing documents through the API","id":"process-existing-documents-through-the-api"},{"depth":2,"value":"View run history","id":"view-run-history"},{"depth":2,"value":"Reprocessing behavior","id":"reprocessing-behavior"},{"depth":2,"value":"When to reprocess","id":"when-to-reprocess"}]},"data":{"title":"Runs and Reprocessing"},"catalogInfo":null,"link":"/docs/ai/document-ai/runs-and-reprocessing/","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"]}