Currently both metadata and index_status are supported.
When updating with a non-null metadata, the document must have index_status of indexed. After this call, the document will have an index_status of not_indexed, since the document will need to reindex with the new metadata.
When updating with a non-null index_status, setting it to not_parsed or not_indexed requires that the document must have index_status of parsing_failed or indexing_failed, respectively.
A 404 Not Found status code will be returned, if the provided collection name or document path does not exist.
If this field is provided, the given metadata json will replace the document's existing metadata json. In other words, if you want to add a new field, you will need to provide the entire metadata object (Both the original fields, and the new field).
If the document is in the index_status of parsing_failed orindexing_failed, then this endpoint allows you to update the index status tonot_parsedandnot_indexed`, respectively. This allows the document to re-attempt to parse/index after failure.
This string will always be "Success!". This may change in the future.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ZeroEntropy","colors":{"primary":"#4594FF","light":"#4594FF","dark":"#4594FF"},"logo":{"light":"https://mintcdn.com/zeroentropy/vsoWdCzEUkYmTkNx/logo/light.svg?fit=max\u0026auto=format\u0026n=vsoWdCzEUkYmTkNx\u0026q=85\u0026s=883fffb78ee34586b7a4f0388d52b135","dark":"https://mintcdn.com/zeroentropy/vsoWdCzEUkYmTkNx/logo/dark.svg?fit=max\u0026auto=format\u0026n=vsoWdCzEUkYmTkNx\u0026q=85\u0026s=5bd022926ce0618ee02fe0091c65ddad","href":"https://www.zeroentropy.dev"},"favicon":"https://mintcdn.com/zeroentropy/vsoWdCzEUkYmTkNx/logo/favicon.svg?fit=max\u0026auto=format\u0026n=vsoWdCzEUkYmTkNx\u0026q=85\u0026s=180816b99903482a5743598ed4ba0205","navbar":{"links":[{"href":"mailto:founders@zeroentropy.dev","label":"Support"},{"href":"https://go.zeroentropy.dev/slack","label":"Community"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.zeroentropy.dev/"}},"footer":{"socials":{"github":"https://github.com/orgs/ZeroEntropy-AI","linkedin":"https://www.linkedin.com/company/zeroentropy-inc"}},"banner":{"content":"๐ [zembed-1](https://docs.zeroentropy.dev/models#zembed-1) is now generally available through the API, all SDKs, and on the AWS Marketplace!","dismissible":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Home page","icon":"house","href":"https://zeroentropy.dev"},{"anchor":"Dashboard","icon":"gauge","href":"https://dashboard.zeroentropy.dev"},{"anchor":"Slack Community","icon":"Slack","href":"https://go.zeroentropy.dev/slack"},{"anchor":"Discord Community","icon":"Discord","href":"https://go.zeroentropy.dev/discord"},{"anchor":"Blog","icon":"newspaper","href":"https://www.zeroentropy.dev/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zeroentropy","hasAudioNarration":false,"actualSubdomain":"zeroentropy","customDomains":["docs.zeroentropy.dev"],"gitSource":{"type":"github","owner":"zeroentropy-ai","repo":"docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e656572b750f6b6f9fab","collectionId":"225e924e-4d36-409f-bad8-21b0833e7a0c","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e656572b750f6b6f9fab:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":15},{"language":"default","tag":"Documentation","count":12},{"language":"default","tag":"Get Started","count":12},{"language":"default","tag":"Documents","count":6},{"language":"default","tag":"Examples","count":5},{"language":"default","tag":"Queries","count":3},{"language":"default","tag":"Collections","count":3},{"language":"default","tag":"Models","count":2},{"language":"default","tag":"Status","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/documents/update-document","slug":"/api-reference/documents/update-document","pageMetadata":{"title":"Update Document","description":"Updates a document. This endpoint is atomic.\n\nCurrently both `metadata` and `index_status` are supported.\n\n- When updating with a non-null `metadata`, the document must have `index_status` of `indexed`. After this call, the document will have an `index_status` of `not_indexed`, since the document will need to reindex with the new metadata.\n- When updating with a non-null `index_status`, setting it to `not_parsed` or `not_indexed` requires that the document must have `index_status` of `parsing_failed` or `indexing_failed`, respectively.\n\nA `404 Not Found` status code will be returned, if the provided collection name or document path does not exist.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /documents/update-document","href":"/api-reference/documents/update-document","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Updates a document. This endpoint is atomic.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Currently both \", _jsx(_components.code, {\n children: \"metadata\"\n }), \" and \", _jsx(_components.code, {\n children: \"index_status\"\n }), \" are supported.\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"When updating with a non-null \", _jsx(_components.code, {\n children: \"metadata\"\n }), \", the document must have \", _jsx(_components.code, {\n children: \"index_status\"\n }), \" of \", _jsx(_components.code, {\n children: \"indexed\"\n }), \". After this call, the document will have an \", _jsx(_components.code, {\n children: \"index_status\"\n }), \" of \", _jsx(_components.code, {\n children: \"not_indexed\"\n }), \", since the document will need to reindex with the new metadata.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"When updating with a non-null \", _jsx(_components.code, {\n children: \"index_status\"\n }), \", setting it to \", _jsx(_components.code, {\n children: \"not_parsed\"\n }), \" or \", _jsx(_components.code, {\n children: \"not_indexed\"\n }), \" requires that the document must have \", _jsx(_components.code, {\n children: \"index_status\"\n }), \" of \", _jsx(_components.code, {\n children: \"parsing_failed\"\n }), \" or \", _jsx(_components.code, {\n children: \"indexing_failed\"\n }), \", respectively.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A \", _jsx(_components.code, {\n children: \"404 Not Found\"\n }), \" status code will be returned, if the provided collection name or document path does not exist.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update Document","description":"Updates a document. This endpoint is atomic.\n\nCurrently both `metadata` and `index_status` are supported.\n\n- When updating with a non-null `metadata`, the document must have `index_status` of `indexed`. After this call, the document will have an `index_status` of `not_indexed`, since the document will need to reindex with the new metadata.\n- When updating with a non-null `index_status`, setting it to `not_parsed` or `not_indexed` requires that the document must have `index_status` of `parsing_failed` or `indexing_failed`, respectively.\n\nA `404 Not Found` status code will be returned, if the provided collection name or document path does not exist.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /documents/update-document","href":"/api-reference/documents/update-document","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Documents"],"summary":"Update Document","description":"Updates a document. This endpoint is atomic.\n\nCurrently both `metadata` and `index_status` are supported.\n\n- When updating with a non-null `metadata`, the document must have `index_status` of `indexed`. After this call, the document will have an `index_status` of `not_indexed`, since the document will need to reindex with the new metadata.\n- When updating with a non-null `index_status`, setting it to `not_parsed` or `not_indexed` requires that the document must have `index_status` of `parsing_failed` or `indexing_failed`, respectively.\n\nA `404 Not Found` status code will be returned, if the provided collection name or document path does not exist.","operationId":"update_document_documents_update_document_post","requestBody":"07921641-bb5e-4db5-8dc7-f4dc4eb5a46e","responses":{"200":"41749ac6-31f6-4dce-ab24-1561e3fbd489","400":"663315f4-fd67-4286-9407-a6577a6f7119","404":"55c383c7-91fc-4d1e-b1e9-a1fc160ae82d","422":"f83eecc1-dd3a-4ffd-be5f-3e83c2e64197"},"security":["9e82d58d-3f36-457b-82b1-ecc38dc99cb1"],"method":"post","type":"path","servers":["0cde098e-13a5-4967-a867-cb1c6027236e","378be2ab-b06b-4fad-8ceb-c71a9acec23c"],"path":"/documents/update-document","baseUrlOptions":["https://api.zeroentropy.dev/v1","https://eu-api.zeroentropy.dev/v1"],"title":"Update Document","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"collection_name":{"type":"string","title":"Collection Name","description":"The name of the collection.","isRequired":true,"uniqueKey":"collection_name","typeLabel":"string"},"path":{"type":"string","title":"Path","description":"The filepath of the document that you are updating. A `404 Not Found` status code will be returned if no document with this path was found.","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"metadata":{"oneOf":[{"type":"object","description":"If this field is provided, the given metadata json will replace the document's existing metadata json. In other words, if you want to add a new field, you will need to provide the entire metadata object (Both the original fields, and the new field).","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties.oneOf.1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0.additionalProperties.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string | string[]"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"If this field is provided, the given metadata json will replace the document's existing metadata json. In other words, if you want to add a new field, you will need to provide the entire metadata object (Both the original fields, and the new field).","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"index_status":{"oneOf":[{"type":"string","title":"Index Status","description":"If the document is in the index_status of `parsing_failed or `indexing_failed`, then this endpoint allows you to update the index status to `not_parsed` and `not_indexed`, respectively. This allows the document to re-attempt to parse/index after failure.","enum":["not_parsed","not_indexed"],"uniqueKey":"index_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Index Status","description":"If the document is in the index_status of `parsing_failed or `indexing_failed`, then this endpoint allows you to update the index status to `not_parsed` and `not_indexed`, respectively. This allows the document to re-attempt to parse/index after failure.","uniqueKey":"index_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"index_status","typeLabel":"enum\u003cstring> | null"}},"type":"object","required":["collection_name","path"],"title":"UpdateDocumentRequest","uniqueKey":"","typeLabel":"UpdateDocumentRequest ยท object"},"examples":{"Example":{"title":"Example","value":{"collection_name":"\u003cstring>","path":"\u003cstring>","metadata":{}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"41749ac6-31f6-4dce-ab24-1561e3fbd489":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message","description":"This string will always be \"Success!\". This may change in the future.","default":"Success!","uniqueKey":"message","typeLabel":"string"}},"type":"object","title":"DefaultResponse","uniqueKey":"","typeLabel":"DefaultResponse ยท object"},"examples":{"Example":{"title":"Example","value":{"message":"Success!"}}},"exampleType":"generated"}},"exampleType":"generated"},"663315f4-fd67-4286-9407-a6577a6f7119":{"description":"Bad Request","content":{"application/json":{"example":{"detail":"Description of Error"},"examples":{"Example":{"title":"Example","value":{"detail":"Description of Error"}}},"exampleType":"examples"}},"exampleType":"examples"},"55c383c7-91fc-4d1e-b1e9-a1fc160ae82d":{"description":"Not Found","content":{"application/json":{"example":{"detail":"Description of Error"},"examples":{"Example":{"title":"Example","value":{"detail":"Description of Error"}}},"exampleType":"examples"}},"exampleType":"examples"},"f83eecc1-dd3a-4ffd-be5f-3e83c2e64197":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError ยท object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError ยท object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError ยท object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9e82d58d-3f36-457b-82b1-ecc38dc99cb1":{"HTTPBearer":{"type":"http","description":"The `Authorization` header must be provided in the format `Bearer \u003cyour-api-key>`.\n\nYou can get your API Key at the [Dashboard](https://dashboard.zeroentropy.dev/)!","scheme":"bearer","scopes":[]}}},"servers":{"0cde098e-13a5-4967-a867-cb1c6027236e":{"url":"https://api.zeroentropy.dev/v1","description":"ZeroEntropy API"},"378be2ab-b06b-4fad-8ceb-c71a9acec23c":{"url":"https://eu-api.zeroentropy.dev/v1","description":"ZeroEntropy API (EU datacenters)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"The `Authorization` header must be provided in the format `Bearer \u003cyour-api-key>`.\n\nYou can get your API Key at the [Dashboard](https://dashboard.zeroentropy.dev/)!","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The `Authorization` header must be provided in the format `Bearer \u003cyour-api-key>`.\n\nYou can get your API Key at the [Dashboard](https://dashboard.zeroentropy.dev/)!","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"zeroentropy","siteName":"ZeroEntropy","title":"Update Document - ZeroEntropy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-23T21:33:04.563Z","originalFileLocation":"api-reference/documents/update-document.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Updates a document. This endpoint is atomic. Currently both metadata and index_status are supported. - When updating with a non-null metadata, the document must have index_status of indexed. After this call, the document will have an index_status of not_indexed, since the document will need to reindex with the new metadata. - When updating with a non-null index_status, setting it to not_parsed or not_indexed requires that the document must have index_status of parsing_failed or indexing_failed, respectively. A 404 Not Found status code will be returned, if the provided collection name or document path does not exist.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ZeroEntropy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Document - ZeroEntropy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a document. This endpoint is atomic. Currently both metadata and index_status are supported. - When updating with a non-null metadata, the document must have index_status of indexed. After this call, the document will have an index_status of not_indexed, since the document will need to reindex with the new metadata. - When updating with a non-null index_status, setting it to not_parsed or not_indexed requires that the document must have index_status of parsing_failed or indexing_failed, respectively. A 404 Not Found status code will be returned, if the provided collection name or document path does not exist.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ZeroEntropy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.zeroentropy.dev/api-reference/documents/update-document\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zeroentropy.mintlify.app/_mintlify/api/og/v2?division=Documents\u0026amp;title=Update+Document\u0026amp;description=Updates+a+document.+This+endpoint+is+atomic.%0A%0ACurrently+both+%60metadata%60+and+%60index_status%60+are+supported.%0A%0A-+When+updating+with+a+non-null+%60metadata%60%2C+the+docum\u0026amp;theme=c9ad13182ecba320a6704ed8\u0026amp;signature=a0e2df6a02b443ed849de4cdab8b7d5062e71be3a913c1a4d3b5e2803cfc3d42\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update Document - ZeroEntropy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a document. This endpoint is atomic. Currently both metadata and index_status are supported. - When updating with a non-null metadata, the document must have index_status of indexed. After this call, the document will have an index_status of not_indexed, since the document will need to reindex with the new metadata. - When updating with a non-null index_status, setting it to not_parsed or not_indexed requires that the document must have index_status of parsing_failed or indexing_failed, respectively. A 404 Not Found status code will be returned, if the provided collection name or document path does not exist.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zeroentropy.mintlify.app/_mintlify/api/og/v2?division=Documents\u0026amp;title=Update+Document\u0026amp;description=Updates+a+document.+This+endpoint+is+atomic.%0A%0ACurrently+both+%60metadata%60+and+%60index_status%60+are+supported.%0A%0A-+When+updating+with+a+non-null+%60metadata%60%2C+the+docum\u0026amp;theme=c9ad13182ecba320a6704ed8\u0026amp;signature=a0e2df6a02b443ed849de4cdab8b7d5062e71be3a913c1a4d3b5e2803cfc3d42\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ZeroEntropy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4594FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.zeroentropy.dev/api-reference/documents/update-document\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/documents/update-document.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.zeroentropy.dev/#organization\",\"name\":\"ZeroEntropy\",\"url\":\"https://docs.zeroentropy.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zeroentropy/vsoWdCzEUkYmTkNx/logo/light.svg?fit=max\u0026auto=format\u0026n=vsoWdCzEUkYmTkNx\u0026q=85\u0026s=883fffb78ee34586b7a4f0388d52b135\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.zeroentropy.dev#website\",\"name\":\"ZeroEntropy\",\"url\":\"https://docs.zeroentropy.dev\",\"publisher\":{\"@id\":\"https://docs.zeroentropy.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.zeroentropy.dev/api-reference/documents/update-document#webpage\",\"url\":\"https://docs.zeroentropy.dev/api-reference/documents/update-document\",\"name\":\"Update Document\",\"description\":\"Updates a document. This endpoint is atomic. Currently both metadata and index_status are supported. - When updating with a non-null metadata, the document must have index_status of indexed. After this call, the document will have an index_status of not_indexed, since the document will need to reindex with the new metadata. - When updating with a non-null index_status, setting it to not_parsed or not_indexed requires that the document must have index_status of parsing_failed or indexing_failed, respectively. A 404 Not Found status code will be returned, if the provided collection name or document path does not exist.\",\"dateModified\":\"2026-04-23T21:33:04.563Z\",\"isPartOf\":{\"@id\":\"https://docs.zeroentropy.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.zeroentropy.dev/api-reference/documents/update-document#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.zeroentropy.dev/api-reference/documents/update-document#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Documents\",\"item\":\"https://docs.zeroentropy.dev/api-reference/documents/add-document\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Document\",\"item\":\"https://docs.zeroentropy.dev/api-reference/documents/update-document\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.zeroentropy.dev/api-reference/documents/update-document#apireference\",\"headline\":\"Update Document\",\"name\":\"Update Document\",\"description\":\"Updates a document. This endpoint is atomic. Currently both metadata and index_status are supported. - When updating with a non-null metadata, the document must have index_status of indexed. After this call, the document will have an index_status of not_indexed, since the document will need to reindex with the new metadata. - When updating with a non-null index_status, setting it to not_parsed or not_indexed requires that the document must have index_status of parsing_failed or indexing_failed, respectively. A 404 Not Found status code will be returned, if the provided collection name or document path does not exist.\",\"url\":\"https://docs.zeroentropy.dev/api-reference/documents/update-document\",\"mainEntityOfPage\":{\"@id\":\"https://docs.zeroentropy.dev/api-reference/documents/update-document#webpage\"},\"dateModified\":\"2026-04-23T21:33:04.563Z\",\"publisher\":{\"@id\":\"https://docs.zeroentropy.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.zeroentropy.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ZeroEntropy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ZeroEntropy","nav":{"global":{"anchors":[{"anchor":"Home page","icon":"house","href":"https://zeroentropy.dev"},{"anchor":"Dashboard","icon":"gauge","href":"https://dashboard.zeroentropy.dev"},{"anchor":"Slack Community","icon":"Slack","href":"https://go.zeroentropy.dev/slack"},{"anchor":"Discord Community","icon":"Discord","href":"https://go.zeroentropy.dev/discord"},{"anchor":"Blog","icon":"newspaper","href":"https://www.zeroentropy.dev/blog"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Admin","pages":[]},{"group":"Usage","pages":[]},{"group":"Models","pages":[{"title":"Rerank","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /models/rerank","href":"/api-reference/models/rerank"},{"title":"Embed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /models/embed","href":"/api-reference/models/embed"}]},{"group":"Status","pages":[{"openapi":"post /status/get-status","title":"Get Status","href":"/api-reference/status/get-status"}]},{"group":"Collections","pages":[{"title":"Add Collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /collections/add-collection","href":"/api-reference/collections/add-collection"},{"title":"Get Collection List","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /collections/get-collection-list","href":"/api-reference/collections/get-collection-list"},{"title":"Delete Collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /collections/delete-collection","href":"/api-reference/collections/delete-collection"}]},{"group":"Documents","pages":[{"title":"Add Document","openapi":"POST /documents/add-document","description":"Adds a document to a given collection.\n\nA status code of `201 Created` will be returned if a document was successfully added. A status code of `409 Conflict` will be returned if the given collection already has a document with the same path.\n\nIf `overwrite` is given a value of `true`, then a status code of `200 OK` will be returned if a document was overwritten (Rather than a status code of `409 Conflict`).\n\nWhen a document is inserted, it can take time to appear in the index. Check the `/status/get-status` endpoint to see progress.","href":"/api-reference/documents/add-document"},{"title":"Update Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /documents/update-document","href":"/api-reference/documents/update-document"},{"openapi":"post /documents/get-document-info","title":"Get Document Info","description":"Retrieves information about a specific document. The request parameters define what information you would like to receive.\n\nA `404 Not Found` will be returned if either the collection name does not exist, or the document path does not exist within the provided collection.","href":"/api-reference/documents/get-document-info"},{"openapi":"post /documents/get-document-info-list","title":"Get Document Info List","href":"/api-reference/documents/get-document-info-list"},{"openapi":"post /documents/delete-document","title":"Delete Document","href":"/api-reference/documents/delete-document"},{"title":"Get Page Info","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /documents/get-page-info","href":"/api-reference/documents/get-page-info"}]},{"group":"Queries","pages":[{"openapi":"post /queries/top-documents","title":"Top Documents","href":"/api-reference/queries/top-documents"},{"title":"Top Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /queries/top-pages","href":"/api-reference/queries/top-pages"},{"openapi":"post /queries/top-snippets","title":"Top Snippets","href":"/api-reference/queries/top-snippets"}]}]}]},"basePath":"","title":"Update Document - ZeroEntropy","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-CX_qQQOL.js","dist-BTZUMDnx.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-xpJZXxdP.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","AssistantPageLink-DqdKa2R4.js"]}