Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}.
You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Affinda Extract Documentation","description":"Affinda Extract is a document AI platform that turns unstructured documents into structured, validated data through extraction, classification, splitting, and human review. Guides, API reference, and configuration playbooks for building and integrating Affinda models.","colors":{"primary":"#1F3339","light":"#A6FFFB","dark":"#A6FFFB"},"logo":{"light":"https://mintcdn.com/affinda-44/nvZZjc-QOoHXzSQ7/images/affindaextract-inkwell.png?fit=max\u0026auto=format\u0026n=nvZZjc-QOoHXzSQ7\u0026q=85\u0026s=a3e52ff1e274ac5509589a6350b41496","dark":"https://mintcdn.com/affinda-44/lcBcXTOY4DEPcniI/images/affindaextract-greenmist.png?fit=max\u0026auto=format\u0026n=lcBcXTOY4DEPcniI\u0026q=85\u0026s=318f55893ae70c89849919adbbc1a545","href":"https://www.affinda.com/"},"favicon":"https://mintcdn.com/affinda-44/zzz2NA-YwjYcDdgi/Affinda_GreenMist_inkwell_Favicon.png?fit=max\u0026auto=format\u0026n=zzz2NA-YwjYcDdgi\u0026q=85\u0026s=c83f557178ec0b196bef5bafec9b9faf","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript"],"prefill":false}},"appearance":{"default":"system","strict":false},"background":{"decoration":"gradient","color":{"light":"#FFF9F0","dark":"#102A2F"}},"navbar":{"links":[{"href":"https://www.affinda.com/pricing-plans","label":"Pricing"},{"href":"https://trust.affinda.com/","label":"Security"},{"href":"https://www.affinda.com/contact","label":"Contact"},{"href":"/support","label":"Support"}],"primary":{"type":"button","label":"Log in","href":"https://app.affinda.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/affinda","youtube":"https://www.youtube.com/@affinda","github":"https://github.com/affinda"}},"seo":{"metatags":{"og:image":"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/68ae96fe8f3fdbbe0ae04c73_Affinda%20Open%20Graph%20image%20for%20website%20previews.png","og:site_name":"Affinda","twitter:site":"@affinda"}},"fonts":{"heading":{"family":"NeuSans","weight":500,"source":"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/685b584938c8018fa3d2e9da_NeuSans-Bold.woff2","format":"woff2"},"body":{"family":"NeuSans","weight":400,"source":"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/685b5849e08b8110997b8e4f_NeuSans-Regular.woff2","format":"woff2"}},"integrations":{"gtm":{"tagId":"GTM-NCW6M2B"}},"banner":{"content":"New to resume parsing? Start with the [Resume Parser console](https://resume-parser.affinda.com/). (Existing resume parsing integrations continue to be supported by Affinda Extract.)","color":{"light":"#102A2F","dark":"#102A2F"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"affinda-44","hasAudioNarration":false,"actualSubdomain":"affinda-44","customDomains":["docs.affinda.com"],"gitSource":{"type":"github","owner":"affinda","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae7acad2102be7f643b74a0","collectionId":"41f0c355-0a3e-4328-9be0-f886baa2e025","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae7acad2102be7f643b74a0"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae7adaa25d97c0814f40b37","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":163},{"language":"default","tag":"Endpoints","count":108},{"language":"default","tag":"Deprecated Versions","count":45},{"language":"default","tag":"v2 Endpoints (Legacy)","count":45},{"language":"default","tag":"Configuration Guide","count":26},{"language":"default","tag":"Deprecated End Points","count":25},{"language":"default","tag":"Search \u0026 Match","count":24},{"language":"default","tag":"Extract Handbook","count":13},{"language":"default","tag":"Additional Resources","count":10},{"language":"default","tag":"Data Sources","count":10}]},"assistantConfig":{"enableAskAiButton":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@affinda.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html.dark{--tw-prose-body: #FFF9F0;--tw-prose-headings: #FFFFFF;--tw-prose-bullets: #FFFFFF}html.dark .mdx-content{color:#FFF9F0}span.text-white.z-10{color:#000000!important}#navbar-primary-cta,#navbar-primary-cta *,a[href=\"https://app.affinda.com\"],a[href=\"https://app.affinda.com\"] *,#navbar a[href*=\"app.affinda.com\"],#navbar a[href*=\"app.affinda.com\"] *{color:#000000!important}"}],"page":{"pagePath":"api-reference/documents/update-a-document","slug":"/api-reference/documents/update-a-document","pageMetadata":{"title":"Update a document","description":"Update file name, expiry time, or move to another collection, etc.","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/documents/{identifier}","href":"/api-reference/documents/update-a-document","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Update file name, expiry time, or move to another collection, etc.\"\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 a document","description":"Update file name, expiry time, or move to another collection, etc.","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/documents/{identifier}","href":"/api-reference/documents/update-a-document","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Documents"],"summary":"Update a document","operationId":"updateDocument","description":"Update file name, expiry time, or move to another collection, etc.","parameters":["4c8cfc8e-d1cb-401f-8298-3e3ea4147434","fb3ec7d3-3169-4a7e-ac37-0cbd974c2946","7d626894-a121-4edd-95fe-cb197ce55e9d"],"requestBody":"cac7842f-ec9f-40ac-b6d7-175e18a1cd7e","responses":{"200":"ce03fcf9-cea5-4c98-a19d-d5497e54180a","400":"f8da03b0-2538-4e8f-9e5c-e731767f12c2","401":"2133490e-bdbc-4425-8a0e-3e6fff4100b4","default":"9adafb57-bcc3-484c-921a-76bdaae4a18c"},"method":"patch","type":"path","servers":["22b901d7-22af-42f1-9666-f9832a1fc626"],"security":["245b976a-4220-4978-9788-de711007412b"],"path":"/v3/documents/{identifier}","baseUrlOptions":["https://{region}.affinda.com"],"title":"Update a document","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4c8cfc8e-d1cb-401f-8298-3e3ea4147434":{"in":"path","required":true,"name":"identifier","description":"Document's identifier","schema":{"type":"string","description":"Document's identifier\nUnique identifier for the document","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"fb3ec7d3-3169-4a7e-ac37-0cbd974c2946":{"in":"query","name":"compact","required":false,"description":"If \"true\", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is \"false\".","schema":{"type":"boolean","isRequired":false,"description":"If \"true\", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is \"false\".","uniqueKey":"","typeLabel":"boolean"}},"7d626894-a121-4edd-95fe-cb197ce55e9d":{"in":"query","name":"snake_case","required":false,"description":"Whether to return the response in snake_case instead of camelCase. Default is false.","schema":{"type":"boolean","isRequired":false,"description":"Whether to return the response in snake_case instead of camelCase. Default is false.","uniqueKey":"","typeLabel":"boolean"}}},"requestBody":{"description":"Document data to update","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"collection":{"type":"string","description":"Uniquely identify a collection.","example":"mEFayXdO","uniqueKey":"collection","typeLabel":"string"},"workspace":{"type":"string","description":"Uniquely identify a workspace.","example":"mEFayXdO","uniqueKey":"workspace","typeLabel":"string"},"documentType":{"oneOf":[{"type":"string","description":"The document type's identifier. Provide if you already know the document type.","uniqueKey":"documentType.oneOf.0","typeLabel":"string"},{"type":"null","description":"The document type's identifier. Provide if you already know the document type.","uniqueKey":"documentType.oneOf.1","typeLabel":"null"}],"uniqueKey":"documentType","typeLabel":"string | null"},"fileName":{"oneOf":[{"type":"string","description":"Optional filename of the file","example":"Document.pdf","uniqueKey":"fileName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional filename of the file","example":"Document.pdf","uniqueKey":"fileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fileName","typeLabel":"string | null"},"expiryTime":{"oneOf":[{"type":"string","format":"date-time","description":"The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.","uniqueKey":"expiryTime.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.","uniqueKey":"expiryTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiryTime","typeLabel":"string\u003cdate-time> | null"},"isConfirmed":{"type":"boolean","uniqueKey":"isConfirmed","typeLabel":"boolean"},"isRejected":{"type":"boolean","uniqueKey":"isRejected","typeLabel":"boolean"},"isArchived":{"type":"boolean","uniqueKey":"isArchived","typeLabel":"boolean"},"skipParse":{"type":"boolean","uniqueKey":"skipParse","typeLabel":"boolean"},"language":{"oneOf":[{"type":"string","description":"Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.","example":"en","uniqueKey":"language.oneOf.0","typeLabel":"string"},{"type":"null","description":"Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.","example":"en","uniqueKey":"language.oneOf.1","typeLabel":"null"}],"uniqueKey":"language","typeLabel":"string | null"},"identifier":{"type":"string","description":"Deprecated in favor of `customIdentifier`.","deprecated":true,"uniqueKey":"identifier","typeLabel":"string"},"customIdentifier":{"type":"string","description":"Specify a custom identifier for the document if you need one, not required to be unique.","uniqueKey":"customIdentifier","typeLabel":"string"},"llmHint":{"oneOf":[{"type":"string","description":"Optional hint inserted into the LLM prompt when processing this document.","uniqueKey":"llmHint.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional hint inserted into the LLM prompt when processing this document.","uniqueKey":"llmHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"llmHint","typeLabel":"string | null"},"warningMessages":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"warningCode":{"oneOf":[{"type":"string","example":"too_many_pages","uniqueKey":"warningMessages.items.[INDEX].warningCode.oneOf.0","typeLabel":"string"},{"type":"null","example":"too_many_pages","uniqueKey":"warningMessages.items.[INDEX].warningCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"warningMessages.items.[INDEX].warningCode","typeLabel":"string | null"},"warningDetail":{"oneOf":[{"type":"string","example":"File exceeds maximum number of pages allowed, parsing the first 10 pages only.","uniqueKey":"warningMessages.items.[INDEX].warningDetail.oneOf.0","typeLabel":"string"},{"type":"null","example":"File exceeds maximum number of pages allowed, parsing the first 10 pages only.","uniqueKey":"warningMessages.items.[INDEX].warningDetail.oneOf.1","typeLabel":"null"}],"uniqueKey":"warningMessages.items.[INDEX].warningDetail","typeLabel":"string | null"}},"uniqueKey":"warningMessages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"warningMessages","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"collection":"mEFayXdO","workspace":"mEFayXdO","documentType":"\u003cstring>","fileName":"Document.pdf","expiryTime":"2023-11-07T05:31:56Z","isConfirmed":true,"isRejected":true,"isArchived":true,"skipParse":true,"language":"en","identifier":"\u003cstring>","customIdentifier":"\u003cstring>","llmHint":"\u003cstring>","warningMessages":[{"warningCode":"too_many_pages","warningDetail":"File exceeds maximum number of pages allowed, parsing the first 10 pages only."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ce03fcf9-cea5-4c98-a19d-d5497e54180a":{"description":"Successfully updated document data.","content":{"application/json":{"schema":{"type":"object","required":["meta","extractor"],"properties":{"extractor":{"type":"string","isRequired":true,"uniqueKey":"extractor","typeLabel":"string"},"meta":{"type":"object","required":["identifier","pages","workspace"],"properties":{"identifier":{"type":"string","description":"Unique identifier for the document","isRequired":true,"uniqueKey":"meta.identifier","typeLabel":"string"},"pages":{"type":"array","items":{"type":"object","required":["id","pageIndex","image","width","height","rotation"],"properties":{"id":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"meta.pages.items.[INDEX].id","typeLabel":"integer"},"pageIndex":{"type":"integer","example":0,"minimum":0,"description":"Page number within the document, starts from 0.","isRequired":true,"uniqueKey":"meta.pages.items.[INDEX].pageIndex","typeLabel":"integer"},"image":{"oneOf":[{"type":"string","example":"https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY\u0026Signature=SIG\u0026Expires=1663302062","description":"The URL to the image of the page.","isRequired":true,"uniqueKey":"meta.pages.items.[INDEX].image.oneOf.0","typeLabel":"string"},{"type":"null","example":"https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY\u0026Signature=SIG\u0026Expires=1663302062","description":"The URL to the image of the page.","isRequired":true,"uniqueKey":"meta.pages.items.[INDEX].image.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.pages.items.[INDEX].image","typeLabel":"string | null"},"height":{"type":"number","example":700,"description":"Height of the page's image in px.","isRequired":true,"uniqueKey":"meta.pages.items.[INDEX].height","typeLabel":"number"},"width":{"type":"number","example":500,"description":"Width of the page's image in px.","isRequired":true,"uniqueKey":"meta.pages.items.[INDEX].width","typeLabel":"number"},"rotation":{"type":"integer","example":90,"minimum":-360,"maximum":360,"description":"The degree of rotation applied to the page. Greater than 0 indicates clockwise rotation. Less than 0 indicates counter-clockwise rotation.","isRequired":true,"uniqueKey":"meta.pages.items.[INDEX].rotation","typeLabel":"integer"},"imageTranslated":{"oneOf":[{"type":"string","example":"https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY\u0026Signature=SIG\u0026Expires=1663302062","description":"The URL to the translated image of the page.","uniqueKey":"meta.pages.items.[INDEX].imageTranslated.oneOf.0","typeLabel":"string"},{"type":"null","example":"https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY\u0026Signature=SIG\u0026Expires=1663302062","description":"The URL to the translated image of the page.","uniqueKey":"meta.pages.items.[INDEX].imageTranslated.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.pages.items.[INDEX].imageTranslated","typeLabel":"string | null"}},"uniqueKey":"meta.pages.items.[INDEX]","typeLabel":"object"},"description":"The document's pages.","isRequired":true,"uniqueKey":"meta.pages","typeLabel":"object[]"},"workspace":{"type":"object","required":["identifier"],"properties":{"identifier":{"type":"string","description":"Uniquely identify a workspace.","example":"mEFayXdO","isRequired":true,"uniqueKey":"meta.workspace.identifier","typeLabel":"string"},"name":{"type":"string","uniqueKey":"meta.workspace.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta.workspace","typeLabel":"object"},"customIdentifier":{"oneOf":[{"type":"string","description":"Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.","example":"46ab8b02-0e5b-420c-877c-8b678d46a834","uniqueKey":"meta.customIdentifier.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.","example":"46ab8b02-0e5b-420c-877c-8b678d46a834","uniqueKey":"meta.customIdentifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.customIdentifier","typeLabel":"string | null"},"fileName":{"oneOf":[{"type":"string","description":"Optional filename of the file","example":"Document.pdf","uniqueKey":"meta.fileName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional filename of the file","example":"Document.pdf","uniqueKey":"meta.fileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.fileName","typeLabel":"string | null"},"ready":{"type":"boolean","nullable":false,"example":true,"description":"If true, the document has finished processing. Particularly useful if an endpoint request specified wait=False, when polling use this variable to determine when to stop polling","uniqueKey":"meta.ready","typeLabel":"boolean"},"readyDt":{"oneOf":[{"type":"string","format":"date-time","example":"2020-12-10T01:43:32.276724Z","description":"The datetime when the document was ready","uniqueKey":"meta.readyDt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2020-12-10T01:43:32.276724Z","description":"The datetime when the document was ready","uniqueKey":"meta.readyDt.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.readyDt","typeLabel":"string\u003cdate-time> | null"},"failed":{"type":"boolean","nullable":false,"example":false,"description":"If true, some exception was raised during processing. Check the 'error' field of the main return object.","uniqueKey":"meta.failed","typeLabel":"boolean"},"expiryTime":{"oneOf":[{"type":"string","format":"date-time","description":"The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.","uniqueKey":"meta.expiryTime.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.","uniqueKey":"meta.expiryTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.expiryTime","typeLabel":"string\u003cdate-time> | null"},"language":{"oneOf":[{"type":"string","example":"en","description":"The document's language.","uniqueKey":"meta.language.oneOf.0","typeLabel":"string"},{"type":"null","example":"en","description":"The document's language.","uniqueKey":"meta.language.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.language","typeLabel":"string | null"},"pdf":{"oneOf":[{"type":"string","example":"https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY\u0026Signature=SIG\u0026Expires=1663302062","description":"The URL to the document's pdf (if the uploaded document is not already pdf, it's converted to pdf as part of the parsing process).","uniqueKey":"meta.pdf.oneOf.0","typeLabel":"string"},{"type":"null","example":"https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY\u0026Signature=SIG\u0026Expires=1663302062","description":"The URL to the document's pdf (if the uploaded document is not already pdf, it's converted to pdf as part of the parsing process).","uniqueKey":"meta.pdf.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.pdf","typeLabel":"string | null"},"parentDocument":{"oneOf":[{"type":"object","description":"If this document is part of a splitted document, this attribute points to the original document that this document is splitted from.","properties":{"identifier":{"type":"string","description":"Unique identifier for the document","uniqueKey":"meta.parentDocument.oneOf.0.identifier","typeLabel":"string"},"customIdentifier":{"oneOf":[{"type":"string","description":"Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.","example":"46ab8b02-0e5b-420c-877c-8b678d46a834","uniqueKey":"meta.parentDocument.oneOf.0.customIdentifier.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.","example":"46ab8b02-0e5b-420c-877c-8b678d46a834","uniqueKey":"meta.parentDocument.oneOf.0.customIdentifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.parentDocument.oneOf.0.customIdentifier","typeLabel":"string | null"}},"uniqueKey":"meta.parentDocument.oneOf.0","typeLabel":"object"},{"type":"null","description":"If this document is part of a splitted document, this attribute points to the original document that this document is splitted from.","properties":{"identifier":{"type":"string","description":"Unique identifier for the document"},"customIdentifier":{"oneOf":[{"type":"string","description":"Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.","example":"46ab8b02-0e5b-420c-877c-8b678d46a834"},{"type":"null","description":"Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.","example":"46ab8b02-0e5b-420c-877c-8b678d46a834"}]}},"uniqueKey":"meta.parentDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.parentDocument","typeLabel":"object | null"},"childDocuments":{"type":"array","description":"If this document has been splitted into a number of child documents, this attribute points to those child documents.","items":{"type":"object","properties":{"identifier":{"type":"string","description":"Unique identifier for the document","uniqueKey":"meta.childDocuments.items.[INDEX].identifier","typeLabel":"string"},"customIdentifier":{"oneOf":[{"type":"string","description":"Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.","example":"46ab8b02-0e5b-420c-877c-8b678d46a834","uniqueKey":"meta.childDocuments.items.[INDEX].customIdentifier.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.","example":"46ab8b02-0e5b-420c-877c-8b678d46a834","uniqueKey":"meta.childDocuments.items.[INDEX].customIdentifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.childDocuments.items.[INDEX].customIdentifier","typeLabel":"string | null"}},"uniqueKey":"meta.childDocuments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"meta.childDocuments","typeLabel":"object[]"},"isOcrd":{"type":"boolean","uniqueKey":"meta.isOcrd","typeLabel":"boolean"},"ocrConfidence":{"oneOf":[{"type":"number","uniqueKey":"meta.ocrConfidence.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"meta.ocrConfidence.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.ocrConfidence","typeLabel":"number | null"},"reviewUrl":{"oneOf":[{"type":"string","uniqueKey":"meta.reviewUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"meta.reviewUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.reviewUrl","typeLabel":"string | null"},"documentType":{"oneOf":[{"type":"string","description":"The document type's identifier. Provide if you already know the document type.","uniqueKey":"meta.documentType.oneOf.0","typeLabel":"string"},{"type":"null","description":"The document type's identifier. Provide if you already know the document type.","uniqueKey":"meta.documentType.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.documentType","typeLabel":"string | null"},"collection":{"oneOf":[{"type":"object","required":["identifier"],"properties":{"identifier":{"type":"string","description":"Uniquely identify a collection.","example":"mEFayXdO","isRequired":true,"uniqueKey":"meta.collection.oneOf.0.identifier","typeLabel":"string"},"name":{"type":"string","uniqueKey":"meta.collection.oneOf.0.name","typeLabel":"string"},"extractor":{"oneOf":[{"type":"object","properties":{"identifier":{"type":"string","description":"Uniquely identify an extractor.","example":"resume","uniqueKey":"meta.collection.oneOf.0.extractor.oneOf.0.identifier","typeLabel":"string"},"name":{"type":"string","uniqueKey":"meta.collection.oneOf.0.extractor.oneOf.0.name","typeLabel":"string"},"baseExtractor":{"oneOf":[{"type":"string","description":"Base extractor's identifier.","uniqueKey":"meta.collection.oneOf.0.extractor.oneOf.0.baseExtractor.oneOf.0","typeLabel":"string"},{"type":"null","description":"Base extractor's identifier.","uniqueKey":"meta.collection.oneOf.0.extractor.oneOf.0.baseExtractor.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.collection.oneOf.0.extractor.oneOf.0.baseExtractor","typeLabel":"string | null"},"validatable":{"type":"boolean","uniqueKey":"meta.collection.oneOf.0.extractor.oneOf.0.validatable","typeLabel":"boolean"}},"uniqueKey":"meta.collection.oneOf.0.extractor.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"identifier":{"type":"string","description":"Uniquely identify an extractor.","example":"resume"},"name":{"type":"string"},"baseExtractor":{"oneOf":[{"type":"string","description":"Base extractor's identifier."},{"type":"null","description":"Base extractor's identifier."}]},"validatable":{"type":"boolean"}},"uniqueKey":"meta.collection.oneOf.0.extractor.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.collection.oneOf.0.extractor","typeLabel":"object | null"},"validationRules":{"type":"array","items":{"type":"object","additionalProperties":false,"nullable":false,"description":"A validation rule for a collection","required":["slug","dataPoints"],"properties":{"slug":{"type":"string","description":"The slug of the validation rule, in lowercase snake_case","pattern":"^[a-z0-9_]+$","example":"supplier_name_is_alphanumeric","isRequired":true,"uniqueKey":"meta.collection.oneOf.0.validationRules.items.[INDEX].slug","typeLabel":"string"},"dataPoints":{"type":"array","description":"The data point identifier that this validation rule applies to, can be an empty list if the rule doens't use any data points as sources","items":{"type":"string","description":"A random string that uniquely identify the resource.","uniqueKey":"meta.collection.oneOf.0.validationRules.items.[INDEX].dataPoints.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"meta.collection.oneOf.0.validationRules.items.[INDEX].dataPoints","typeLabel":"string[]"}},"uniqueKey":"meta.collection.oneOf.0.validationRules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"meta.collection.oneOf.0.validationRules","typeLabel":"object[]"},"autoRefreshValidationResults":{"type":"boolean","description":"If True, validation results are refreshed whenever annotations are changed.","uniqueKey":"meta.collection.oneOf.0.autoRefreshValidationResults","typeLabel":"boolean"}},"uniqueKey":"meta.collection.oneOf.0","typeLabel":"object"},{"type":"null","required":["identifier"],"properties":{"identifier":{"type":"string","description":"Uniquely identify a collection.","example":"mEFayXdO"},"name":{"type":"string"},"extractor":{"oneOf":[{"type":"object","properties":{"identifier":{"type":"string","description":"Uniquely identify an extractor.","example":"resume"},"name":{"type":"string"},"baseExtractor":{"oneOf":[{"type":"string","description":"Base extractor's identifier."},{"type":"null","description":"Base extractor's identifier."}]},"validatable":{"type":"boolean"}}},{"type":"null","properties":{"identifier":{"type":"string","description":"Uniquely identify an extractor.","example":"resume"},"name":{"type":"string"},"baseExtractor":{"oneOf":[{"type":"string","description":"Base extractor's identifier."},{"type":"null","description":"Base extractor's identifier."}]},"validatable":{"type":"boolean"}}}]},"validationRules":{"type":"array","items":{"type":"object","additionalProperties":false,"nullable":false,"description":"A validation rule for a collection","required":["slug","dataPoints"],"properties":{"slug":{"type":"string","description":"The slug of the validation rule, in lowercase snake_case","pattern":"^[a-z0-9_]+$","example":"supplier_name_is_alphanumeric"},"dataPoints":{"type":"array","description":"The data point identifier that this validation rule applies to, can be an empty list if the rule doens't use any data points as sources","items":{"type":"string","description":"A random string that uniquely identify the resource."}}}}},"autoRefreshValidationResults":{"type":"boolean","description":"If True, validation results are refreshed whenever annotations are changed."}},"uniqueKey":"meta.collection.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.collection","typeLabel":"object | null"},"archivedDt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"meta.archivedDt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"meta.archivedDt.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.archivedDt","typeLabel":"string\u003cdate-time> | null"},"isArchived":{"type":"boolean","uniqueKey":"meta.isArchived","typeLabel":"boolean"},"skipParse":{"type":"boolean","uniqueKey":"meta.skipParse","typeLabel":"boolean"},"confirmedDt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"meta.confirmedDt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"meta.confirmedDt.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.confirmedDt","typeLabel":"string\u003cdate-time> | null"},"confirmedBy":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","description":"Uniquely identify a user.","example":1,"minimum":1,"uniqueKey":"meta.confirmedBy.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","example":"Carl Johnson","uniqueKey":"meta.confirmedBy.oneOf.0.name","typeLabel":"string"},"username":{"type":"string","example":"carljohnson","uniqueKey":"meta.confirmedBy.oneOf.0.username","typeLabel":"string"},"email":{"type":"string","example":"carljohnson@grove.street","uniqueKey":"meta.confirmedBy.oneOf.0.email","typeLabel":"string"},"avatar":{"oneOf":[{"type":"string","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","uniqueKey":"meta.confirmedBy.oneOf.0.avatar.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","uniqueKey":"meta.confirmedBy.oneOf.0.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.confirmedBy.oneOf.0.avatar","typeLabel":"string | null"}},"uniqueKey":"meta.confirmedBy.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"integer","description":"Uniquely identify a user.","example":1,"minimum":1},"name":{"type":"string","example":"Carl Johnson"},"username":{"type":"string","example":"carljohnson"},"email":{"type":"string","example":"carljohnson@grove.street"},"avatar":{"oneOf":[{"type":"string","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG"},{"type":"null","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG"}]}},"uniqueKey":"meta.confirmedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.confirmedBy","typeLabel":"object | null"},"isConfirmed":{"type":"boolean","uniqueKey":"meta.isConfirmed","typeLabel":"boolean"},"rejectedDt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"meta.rejectedDt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"meta.rejectedDt.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.rejectedDt","typeLabel":"string\u003cdate-time> | null"},"rejectedBy":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","description":"Uniquely identify a user.","example":1,"minimum":1,"uniqueKey":"meta.rejectedBy.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","example":"Carl Johnson","uniqueKey":"meta.rejectedBy.oneOf.0.name","typeLabel":"string"},"username":{"type":"string","example":"carljohnson","uniqueKey":"meta.rejectedBy.oneOf.0.username","typeLabel":"string"},"email":{"type":"string","example":"carljohnson@grove.street","uniqueKey":"meta.rejectedBy.oneOf.0.email","typeLabel":"string"},"avatar":{"oneOf":[{"type":"string","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","uniqueKey":"meta.rejectedBy.oneOf.0.avatar.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","uniqueKey":"meta.rejectedBy.oneOf.0.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.rejectedBy.oneOf.0.avatar","typeLabel":"string | null"}},"uniqueKey":"meta.rejectedBy.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"integer","description":"Uniquely identify a user.","example":1,"minimum":1},"name":{"type":"string","example":"Carl Johnson"},"username":{"type":"string","example":"carljohnson"},"email":{"type":"string","example":"carljohnson@grove.street"},"avatar":{"oneOf":[{"type":"string","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG"},{"type":"null","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG"}]}},"uniqueKey":"meta.rejectedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.rejectedBy","typeLabel":"object | null"},"archivedBy":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","description":"Uniquely identify a user.","example":1,"minimum":1,"uniqueKey":"meta.archivedBy.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","example":"Carl Johnson","uniqueKey":"meta.archivedBy.oneOf.0.name","typeLabel":"string"},"username":{"type":"string","example":"carljohnson","uniqueKey":"meta.archivedBy.oneOf.0.username","typeLabel":"string"},"email":{"type":"string","example":"carljohnson@grove.street","uniqueKey":"meta.archivedBy.oneOf.0.email","typeLabel":"string"},"avatar":{"oneOf":[{"type":"string","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","uniqueKey":"meta.archivedBy.oneOf.0.avatar.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","uniqueKey":"meta.archivedBy.oneOf.0.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.archivedBy.oneOf.0.avatar","typeLabel":"string | null"}},"uniqueKey":"meta.archivedBy.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"integer","description":"Uniquely identify a user.","example":1,"minimum":1},"name":{"type":"string","example":"Carl Johnson"},"username":{"type":"string","example":"carljohnson"},"email":{"type":"string","example":"carljohnson@grove.street"},"avatar":{"oneOf":[{"type":"string","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG"},{"type":"null","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG"}]}},"uniqueKey":"meta.archivedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.archivedBy","typeLabel":"object | null"},"isRejected":{"type":"boolean","uniqueKey":"meta.isRejected","typeLabel":"boolean"},"createdDt":{"type":"string","format":"date-time","uniqueKey":"meta.createdDt","typeLabel":"string\u003cdate-time>"},"errorCode":{"oneOf":[{"type":"string","example":"document_conversion_failed","uniqueKey":"meta.errorCode.oneOf.0","typeLabel":"string"},{"type":"null","example":"document_conversion_failed","uniqueKey":"meta.errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.errorCode","typeLabel":"string | null"},"errorDetail":{"oneOf":[{"type":"string","example":"Unable to convert word document","uniqueKey":"meta.errorDetail.oneOf.0","typeLabel":"string"},{"type":"null","example":"Unable to convert word document","uniqueKey":"meta.errorDetail.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.errorDetail","typeLabel":"string | null"},"file":{"oneOf":[{"type":"string","description":"URL to view the file.","uniqueKey":"meta.file.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL to view the file.","uniqueKey":"meta.file.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.file","typeLabel":"string | null"},"html":{"oneOf":[{"type":"string","description":"URL to view the file converted to HTML.","uniqueKey":"meta.html.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL to view the file converted to HTML.","uniqueKey":"meta.html.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.html","typeLabel":"string | null"},"llmHint":{"oneOf":[{"type":"string","description":"Optional hint inserted into the LLM prompt when processing this document.","uniqueKey":"meta.llmHint.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional hint inserted into the LLM prompt when processing this document.","uniqueKey":"meta.llmHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.llmHint","typeLabel":"string | null"},"tags":{"type":"array","items":{"type":"object","required":["id","name","workspace","documentCount"],"properties":{"id":{"type":"integer","description":"Uniquely identify a tag.","example":1,"minimum":1,"isRequired":true,"uniqueKey":"meta.tags.items.[INDEX].id","typeLabel":"integer"},"name":{"type":"string","isRequired":true,"uniqueKey":"meta.tags.items.[INDEX].name","typeLabel":"string"},"workspace":{"type":"string","description":"Uniquely identify a workspace.","example":"mEFayXdO","isRequired":true,"uniqueKey":"meta.tags.items.[INDEX].workspace","typeLabel":"string"},"documentCount":{"type":"integer","minimum":0,"description":"Number of documents tagged with this.","isRequired":true,"uniqueKey":"meta.tags.items.[INDEX].documentCount","typeLabel":"integer"}},"uniqueKey":"meta.tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"meta.tags","typeLabel":"object[]"},"createdBy":{"type":"object","properties":{"id":{"type":"integer","description":"Uniquely identify a user.","example":1,"minimum":1,"uniqueKey":"meta.createdBy.id","typeLabel":"integer"},"name":{"type":"string","example":"Carl Johnson","uniqueKey":"meta.createdBy.name","typeLabel":"string"},"username":{"type":"string","example":"carljohnson","uniqueKey":"meta.createdBy.username","typeLabel":"string"},"email":{"type":"string","example":"carljohnson@grove.street","uniqueKey":"meta.createdBy.email","typeLabel":"string"},"avatar":{"oneOf":[{"type":"string","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","uniqueKey":"meta.createdBy.avatar.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","uniqueKey":"meta.createdBy.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.createdBy.avatar","typeLabel":"string | null"}},"uniqueKey":"meta.createdBy","typeLabel":"object"},"sourceEmail":{"oneOf":[{"type":"string","description":"If the document is created via email ingestion, this field stores the email file's URL.","uniqueKey":"meta.sourceEmail.oneOf.0","typeLabel":"string"},{"type":"null","description":"If the document is created via email ingestion, this field stores the email file's URL.","uniqueKey":"meta.sourceEmail.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.sourceEmail","typeLabel":"string | null"},"sourceEmailAddress":{"oneOf":[{"type":"string","description":"If the document is created via email ingestion, this field stores the email's From address.","uniqueKey":"meta.sourceEmailAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"If the document is created via email ingestion, this field stores the email's From address.","uniqueKey":"meta.sourceEmailAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.sourceEmailAddress","typeLabel":"string | null"},"regionBias":{"oneOf":[{"type":"object","properties":{"country":{"oneOf":[{"type":"string","description":"A single alpha-2 country code (e.g. AU) used by google geocoding service","uniqueKey":"meta.regionBias.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"A single alpha-2 country code (e.g. AU) used by google geocoding service","uniqueKey":"meta.regionBias.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.regionBias.oneOf.0.country","typeLabel":"string | null"},"countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"meta.regionBias.oneOf.0.countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"A list of alpha-2 country codes used by Pelias","uniqueKey":"meta.regionBias.oneOf.0.countries.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"A list of alpha-2 country codes used by Pelias","uniqueKey":"meta.regionBias.oneOf.0.countries.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.regionBias.oneOf.0.countries","typeLabel":"string[] | null"},"squareCoordinates":{"oneOf":[{"type":"array","items":{"type":"number","uniqueKey":"meta.regionBias.oneOf.0.squareCoordinates.oneOf.0.items.[INDEX]","typeLabel":"number"},"description":"A list of coordinates used by Pelias in the shape of [min_lon, min_lat, max_lon, max_lat]","uniqueKey":"meta.regionBias.oneOf.0.squareCoordinates.oneOf.0","typeLabel":"number[]"},{"type":"null","items":{"type":"number"},"description":"A list of coordinates used by Pelias in the shape of [min_lon, min_lat, max_lon, max_lat]","uniqueKey":"meta.regionBias.oneOf.0.squareCoordinates.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.regionBias.oneOf.0.squareCoordinates","typeLabel":"number[] | null"},"strict":{"type":"boolean","description":"If true, the location must be within the region, as opposed to prefering locations within the region.\nDefault to false.\n","example":true,"uniqueKey":"meta.regionBias.oneOf.0.strict","typeLabel":"boolean"}},"uniqueKey":"meta.regionBias.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"country":{"oneOf":[{"type":"string","description":"A single alpha-2 country code (e.g. AU) used by google geocoding service"},{"type":"null","description":"A single alpha-2 country code (e.g. AU) used by google geocoding service"}]},"countries":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"A list of alpha-2 country codes used by Pelias"},{"type":"null","items":{"type":"string"},"description":"A list of alpha-2 country codes used by Pelias"}]},"squareCoordinates":{"oneOf":[{"type":"array","items":{"type":"number"},"description":"A list of coordinates used by Pelias in the shape of [min_lon, min_lat, max_lon, max_lat]"},{"type":"null","items":{"type":"number"},"description":"A list of coordinates used by Pelias in the shape of [min_lon, min_lat, max_lon, max_lat]"}]},"strict":{"type":"boolean","description":"If true, the location must be within the region, as opposed to prefering locations within the region.\nDefault to false.\n","example":true}},"uniqueKey":"meta.regionBias.oneOf.1","typeLabel":"null"}],"uniqueKey":"meta.regionBias","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"data":{"type":"object","uniqueKey":"data","typeLabel":"object"},"error":{"type":"object","additionalProperties":false,"properties":{"errorCode":{"oneOf":[{"type":"string","example":"document_conversion_failed","uniqueKey":"error.errorCode.oneOf.0","typeLabel":"string"},{"type":"null","example":"document_conversion_failed","uniqueKey":"error.errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.errorCode","typeLabel":"string | null"},"errorDetail":{"oneOf":[{"type":"string","example":"Unable to convert word document","uniqueKey":"error.errorDetail.oneOf.0","typeLabel":"string"},{"type":"null","example":"Unable to convert word document","uniqueKey":"error.errorDetail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.errorDetail","typeLabel":"string | null"}},"uniqueKey":"error","typeLabel":"object"},"warnings":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"warningCode":{"oneOf":[{"type":"string","example":"too_many_pages","uniqueKey":"warnings.items.[INDEX].warningCode.oneOf.0","typeLabel":"string"},{"type":"null","example":"too_many_pages","uniqueKey":"warnings.items.[INDEX].warningCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"warnings.items.[INDEX].warningCode","typeLabel":"string | null"},"warningDetail":{"oneOf":[{"type":"string","example":"File exceeds maximum number of pages allowed, parsing the first 10 pages only.","uniqueKey":"warnings.items.[INDEX].warningDetail.oneOf.0","typeLabel":"string"},{"type":"null","example":"File exceeds maximum number of pages allowed, parsing the first 10 pages only.","uniqueKey":"warnings.items.[INDEX].warningDetail.oneOf.1","typeLabel":"null"}],"uniqueKey":"warnings.items.[INDEX].warningDetail","typeLabel":"string | null"}},"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"warnings","typeLabel":"object[]"}},"discriminator":{"propertyName":"extractor"},"x-csharp-usage":"input,output","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"extractor":"\u003cstring>","meta":{"identifier":"\u003cstring>","pages":[{"id":2,"pageIndex":0,"image":"https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY\u0026Signature=SIG\u0026Expires=1663302062","height":700,"width":500,"rotation":90,"imageTranslated":"https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY\u0026Signature=SIG\u0026Expires=1663302062"}],"workspace":{"identifier":"mEFayXdO","name":"\u003cstring>"},"customIdentifier":"46ab8b02-0e5b-420c-877c-8b678d46a834","fileName":"Document.pdf","ready":true,"readyDt":"2020-12-10T01:43:32.276724Z","failed":false,"expiryTime":"2023-11-07T05:31:56Z","language":"en","pdf":"https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY\u0026Signature=SIG\u0026Expires=1663302062","parentDocument":{"identifier":"\u003cstring>","customIdentifier":"46ab8b02-0e5b-420c-877c-8b678d46a834"},"childDocuments":[{"identifier":"\u003cstring>","customIdentifier":"46ab8b02-0e5b-420c-877c-8b678d46a834"}],"isOcrd":true,"ocrConfidence":123,"reviewUrl":"\u003cstring>","documentType":"\u003cstring>","collection":{"identifier":"mEFayXdO","name":"\u003cstring>","extractor":{"identifier":"resume","name":"\u003cstring>","baseExtractor":"\u003cstring>","validatable":true},"validationRules":[{"slug":"supplier_name_is_alphanumeric","dataPoints":["\u003cstring>"]}],"autoRefreshValidationResults":true},"archivedDt":"2023-11-07T05:31:56Z","isArchived":true,"skipParse":true,"confirmedDt":"2023-11-07T05:31:56Z","confirmedBy":{"id":1,"name":"Carl Johnson","username":"carljohnson","email":"carljohnson@grove.street","avatar":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG"},"isConfirmed":true,"rejectedDt":"2023-11-07T05:31:56Z","rejectedBy":{"id":1,"name":"Carl Johnson","username":"carljohnson","email":"carljohnson@grove.street","avatar":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG"},"archivedBy":{"id":1,"name":"Carl Johnson","username":"carljohnson","email":"carljohnson@grove.street","avatar":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG"},"isRejected":true,"createdDt":"2023-11-07T05:31:56Z","errorCode":"document_conversion_failed","errorDetail":"Unable to convert word document","file":"\u003cstring>","html":"\u003cstring>","llmHint":"\u003cstring>","tags":[{"id":1,"name":"\u003cstring>","workspace":"mEFayXdO","documentCount":1}],"createdBy":{"id":1,"name":"Carl Johnson","username":"carljohnson","email":"carljohnson@grove.street","avatar":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG"},"sourceEmail":"\u003cstring>","sourceEmailAddress":"\u003cstring>","regionBias":{"country":"\u003cstring>","countries":["\u003cstring>"],"squareCoordinates":[123],"strict":true}},"data":{},"error":{"errorCode":"document_conversion_failed","errorDetail":"Unable to convert word document"},"warnings":[{"warningCode":"too_many_pages","warningDetail":"File exceeds maximum number of pages allowed, parsing the first 10 pages only."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"f8da03b0-2538-4e8f-9e5c-e731767f12c2":{"description":"Bad request. If it is a validation error will contain a list of each invalid field","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["type","errors"],"properties":{"type":{"type":"string","example":"validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["attr","code","detail"],"properties":{"attr":{"oneOf":[{"type":"string","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.0","typeLabel":"string"},{"type":"null","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].attr","typeLabel":"string | null"},"code":{"type":"string","example":"unique","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","example":"This index name has already been used","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"validation_error","errors":[{"attr":"non_field_errors","code":"unique","detail":"This index name has already been used"}]}}},"exampleType":"generated"}},"x-ms-error-response":true,"exampleType":"generated"},"2133490e-bdbc-4425-8a0e-3e6fff4100b4":{"description":"Authorisation error","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["type","errors"],"properties":{"type":{"type":"string","example":"validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["attr","code","detail"],"properties":{"attr":{"oneOf":[{"type":"string","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.0","typeLabel":"string"},{"type":"null","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].attr","typeLabel":"string | null"},"code":{"type":"string","example":"unique","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","example":"This index name has already been used","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"validation_error","errors":[{"attr":"non_field_errors","code":"unique","detail":"This index name has already been used"}]}}},"exampleType":"generated"}},"x-ms-error-response":true,"exampleType":"generated"},"9adafb57-bcc3-484c-921a-76bdaae4a18c":{"description":"UnexpectedError","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["type","errors"],"properties":{"type":{"type":"string","example":"validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["attr","code","detail"],"properties":{"attr":{"oneOf":[{"type":"string","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.0","typeLabel":"string"},{"type":"null","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].attr","typeLabel":"string | null"},"code":{"type":"string","example":"unique","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","example":"This index name has already been used","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"validation_error","errors":[{"attr":"non_field_errors","code":"unique","detail":"This index name has already been used"}]}}},"exampleType":"generated"}},"x-ms-error-response":true,"exampleType":"generated"}},"security":{"245b976a-4220-4978-9788-de711007412b":{"ApiKeyAuth":{"type":"http","scheme":"bearer","description":"Basic authentication using an API key, e.g. `{Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}`.\nYou can find your API key within the Settings page of the [Affinda web app](https://app.affinda.com/). You can obtain an API key by [signing up for a free trial](https://app.affinda.com/auth/register).","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"22b901d7-22af-42f1-9666-f9832a1fc626":{"url":"https://{region}.affinda.com","description":"Select the correct server for your instance: api (AUS/Global), api.us1 (US), or api.eu1 (EU).","variables":{"region":{"default":"api","description":"The instance region. Use 'api' for AUS/Global, 'api.us1' for US, or 'api.eu1' for EU. You can find your region in the Affinda web app URL.","enum":["api","api.eu1","api.us1"],"x-ms-parameter-location":"client"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Basic authentication using an API key, e.g. `{Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}`.\nYou can find your API key within the Settings page of the [Affinda web app](https://app.affinda.com/). You can obtain an API key by [signing up for a free trial](https://app.affinda.com/auth/register).","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Basic authentication using an API key, e.g. `{Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}`.\nYou can find your API key within the Settings page of the [Affinda web app](https://app.affinda.com/). You can obtain an API key by [signing up for a free trial](https://app.affinda.com/auth/register).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://api.affinda.com/static/v3/api_spec.yaml"},"subdomain":"affinda-44","siteName":"Affinda Extract Documentation","title":"Update a document - Affinda Extract Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T03:11:07.074Z","originalFileLocation":"api-reference/documents/update-a-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=\"Update file name, expiry time, or move to another collection, etc.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Affinda Extract Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a document - Affinda Extract Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update file name, expiry time, or move to another collection, etc.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Affinda\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.affinda.com/api-reference/documents/update-a-document\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/68ae96fe8f3fdbbe0ae04c73_Affinda%20Open%20Graph%20image%20for%20website%20previews.png\">\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 a document - Affinda Extract Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update file name, expiry time, or move to another collection, etc.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/68ae96fe8f3fdbbe0ae04c73_Affinda%20Open%20Graph%20image%20for%20website%20previews.png\">\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/affinda-44/tl-77mmsQTlzqSAp/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Affinda Extract Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F3339\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.affinda.com/api-reference/documents/update-a-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-a-document.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.affinda.com/#organization\",\"name\":\"Affinda Extract Documentation\",\"url\":\"https://docs.affinda.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/affinda-44/nvZZjc-QOoHXzSQ7/images/affindaextract-inkwell.png?fit=max\u0026auto=format\u0026n=nvZZjc-QOoHXzSQ7\u0026q=85\u0026s=a3e52ff1e274ac5509589a6350b41496\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.affinda.com#website\",\"name\":\"Affinda Extract Documentation\",\"url\":\"https://docs.affinda.com\",\"publisher\":{\"@id\":\"https://docs.affinda.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.affinda.com/api-reference/documents/update-a-document#webpage\",\"url\":\"https://docs.affinda.com/api-reference/documents/update-a-document\",\"name\":\"Update a document\",\"description\":\"Update file name, expiry time, or move to another collection, etc.\",\"dateModified\":\"2026-10-30T03:11:07.074Z\",\"isPartOf\":{\"@id\":\"https://docs.affinda.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.affinda.com/api-reference/documents/update-a-document#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.affinda.com/api-reference/documents/update-a-document#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.affinda.com/api-reference/documents/get-list-of-all-documents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documents\",\"item\":\"https://docs.affinda.com/api-reference/documents/get-list-of-all-documents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a document\",\"item\":\"https://docs.affinda.com/api-reference/documents/update-a-document\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.affinda.com/api-reference/documents/update-a-document#apireference\",\"headline\":\"Update a document\",\"name\":\"Update a document\",\"description\":\"Update file name, expiry time, or move to another collection, etc.\",\"url\":\"https://docs.affinda.com/api-reference/documents/update-a-document\",\"mainEntityOfPage\":{\"@id\":\"https://docs.affinda.com/api-reference/documents/update-a-document#webpage\"},\"image\":\"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/68ae96fe8f3fdbbe0ae04c73_Affinda%20Open%20Graph%20image%20for%20website%20previews.png\",\"dateModified\":\"2026-10-30T03:11:07.074Z\",\"publisher\":{\"@id\":\"https://docs.affinda.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.affinda.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Affinda Extract Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Affinda Extract Documentation","nav":{"global":null,"tabs":[{"tab":"Extract Handbook","pages":[{"title":"Extract Handbook","href":"/home"}]},{"tab":"Configuration Guide","pages":[{"title":"Configuration Guide","href":"/configuration/workflow"}]},{"tab":"API Reference","groups":[{"group":"Developer Guide","pages":[{"title":"API quick start guide","href":"/reference/getting-started"},{"title":"API authentication with rotatable keys","href":"/reference/authentication"},{"group":"Uploading Documents","pages":[{"title":"Document upload options for the API","href":"/reference/upload-options"},{"title":"Field and document metadata in API responses","href":"/reference/metadata"},{"title":"API volume, file size, and rate limits","href":"/reference/limits"}]},{"title":"Webhooks for document and parsing events","href":"/reference/webhooks"},{"title":"Embed the Affinda validation interface","href":"/reference/embedded"}]},{"group":"Developer Tools","pages":[{"title":"Official client libraries for the Affinda API","href":"/reference/client-libraries"},{"title":"Structured outputs with Pydantic models","href":"/reference/pydantic-models"},{"title":"Generate TypeScript interfaces","href":"/reference/typescript-interfaces"}]},{"group":"Endpoints","pages":[{"group":"Documents","pages":[{"title":"Get list of all documents","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/documents","href":"/api-reference/documents/get-list-of-all-documents"},{"title":"Upload a document for parsing","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/documents","href":"/api-reference/documents/upload-a-document-for-parsing"},{"title":"Get specific document","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/documents/{identifier}","href":"/api-reference/documents/get-specific-document"},{"title":"Delete a document","description":"Deletes the specified document from the database.","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/documents/{identifier}","href":"/api-reference/documents/delete-a-document"},{"title":"Update a document","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/documents/{identifier}","href":"/api-reference/documents/update-a-document"},{"title":"Get redacted document","description":"Get the redacted version of a document. The original document is not modified.","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/documents/{identifier}/redacted","href":"/api-reference/documents/get-redacted-document"}]},{"group":"Workspaces","pages":[{"title":"Get list of all workspaces","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/workspaces","href":"/api-reference/workspaces/get-list-of-all-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/workspaces","href":"/api-reference/workspaces/create-a-workspace"},{"title":"Get specific workspace","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/workspaces/{identifier}","href":"/api-reference/workspaces/get-specific-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/workspaces/{identifier}","href":"/api-reference/workspaces/delete-a-workspace"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/workspaces/{identifier}","href":"/api-reference/workspaces/update-a-workspace"}]},{"group":"Document Types","pages":[{"title":"List document types","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/document_types","href":"/api-reference/document-types/list-document-types"},{"title":"Create a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/document_types","href":"/api-reference/document-types/create-a-document-type"},{"title":"Get a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/document_types/{identifier}","href":"/api-reference/document-types/get-a-document-type"},{"title":"Delete a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/document_types/{identifier}","href":"/api-reference/document-types/delete-a-document-type"},{"title":"Update a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/document_types/{identifier}","href":"/api-reference/document-types/update-a-document-type"},{"title":"Generate JSON schema from a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/document_types/{identifier}/json_schema","href":"/api-reference/document-types/generate-json-schema-from-a-document-type"},{"title":"Generate Pydantic models from a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/document_types/{identifier}/pydantic_models","href":"/api-reference/document-types/generate-pydantic-models-from-a-document-type"}]},{"group":"Data Sources","pages":[{"title":"List data sources","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mapping_data_sources","href":"/api-reference/data-sources/list-data-sources"},{"title":"Create a data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/mapping_data_sources","href":"/api-reference/data-sources/create-a-data-source"},{"title":"Get specific data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mapping_data_sources/{identifier}","href":"/api-reference/data-sources/get-specific-data-source"},{"title":"Delete specific data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/mapping_data_sources/{identifier}","href":"/api-reference/data-sources/delete-specific-data-source"},{"title":"List values for a data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mapping_data_sources/{identifier}/values","href":"/api-reference/data-sources/list-values-for-a-data-source"},{"title":"Replace values for a data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml put /v3/mapping_data_sources/{identifier}/values","href":"/api-reference/data-sources/replace-values-for-a-data-source"},{"title":"Add value for a data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/mapping_data_sources/{identifier}/values","href":"/api-reference/data-sources/add-value-for-a-data-source"},{"title":"Get specific data source value","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mapping_data_sources/{identifier}/values/{value}","href":"/api-reference/data-sources/get-specific-data-source-value"},{"title":"Update specific data source value","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml put /v3/mapping_data_sources/{identifier}/values/{value}","href":"/api-reference/data-sources/update-specific-data-source-value"},{"title":"Delete specific data source value","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/mapping_data_sources/{identifier}/values/{value}","href":"/api-reference/data-sources/delete-specific-data-source-value"}]},{"group":"Validation Results","pages":[{"title":"Get list of all validation results","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/validation_results","href":"/api-reference/validation-results/get-list-of-all-validation-results"},{"title":"Create a validation result","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/validation_results","href":"/api-reference/validation-results/create-a-validation-result"},{"title":"Get specific validation result","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/validation_results/{id}","href":"/api-reference/validation-results/get-specific-validation-result"},{"title":"Delete a validation result","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/validation_results/{id}","href":"/api-reference/validation-results/delete-a-validation-result"},{"title":"Update a validation result","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/validation_results/{id}","href":"/api-reference/validation-results/update-a-validation-result"},{"title":"Batch create validation results","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/validation_results/batch_create","href":"/api-reference/validation-results/batch-create-validation-results"},{"title":"Batch delete validation results","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/validation_results/batch_delete","href":"/api-reference/validation-results/batch-delete-validation-results"}]},{"group":"Organizations","pages":[{"title":"Get list of all organizations","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/organizations","href":"/api-reference/organizations/get-list-of-all-organizations"},{"title":"Get detail of an organization","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/organizations/{identifier}","href":"/api-reference/organizations/get-detail-of-an-organization"}]},{"group":"Add x-hidden to endpoints","pages":[]},{"group":"Usage","pages":[{"title":"Get usage","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/usage","href":"/api-reference/usage/get-usage"}]},{"group":"Tags","pages":[{"title":"Get list of all tags","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/tags","href":"/api-reference/tags/get-list-of-all-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Get specific tag","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/tags/{id}","href":"/api-reference/tags/get-specific-tag"},{"title":"Delete an tag","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/tags/{id}","href":"/api-reference/tags/delete-an-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/tags/{id}","href":"/api-reference/tags/update-a-tag"},{"title":"Add a tag to documents","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/documents/batch_add_tag","href":"/api-reference/tags/add-a-tag-to-documents"},{"title":"Remove a tag from documents","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/documents/batch_remove_tag","href":"/api-reference/tags/remove-a-tag-from-documents"}]},{"group":"Annotations","pages":[{"title":"Get list of all annotations","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/annotations","href":"/api-reference/annotations/get-list-of-all-annotations"},{"title":"Create a annotation","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/annotations","href":"/api-reference/annotations/create-a-annotation"},{"title":"Get specific annotation","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/annotations/{id}","href":"/api-reference/annotations/get-specific-annotation"},{"title":"Delete an annotation","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/annotations/{id}","href":"/api-reference/annotations/delete-an-annotation"},{"title":"Update an annotation","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/annotations/{id}","href":"/api-reference/annotations/update-an-annotation"},{"title":"Batch create annotations","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/annotations/batch_create","href":"/api-reference/annotations/batch-create-annotations"},{"title":"Batch update annotations","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/annotations/batch_update","href":"/api-reference/annotations/batch-update-annotations"},{"title":"Batch delete annotations","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/annotations/batch_delete","href":"/api-reference/annotations/batch-delete-annotations"}]},{"group":"Webhooks","pages":[{"title":"Get list of all resthook subscriptions","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resthook_subscriptions","href":"/api-reference/webhooks/get-list-of-all-resthook-subscriptions"},{"title":"Create a resthook subscription","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/resthook_subscriptions","href":"/api-reference/webhooks/create-a-resthook-subscription"},{"title":"Get specific resthook subscription","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resthook_subscriptions/{id}","href":"/api-reference/webhooks/get-specific-resthook-subscription"},{"title":"Delete a resthook subscription","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/resthook_subscriptions/{id}","href":"/api-reference/webhooks/delete-a-resthook-subscription"},{"title":"Update a resthook subscription","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/resthook_subscriptions/{id}","href":"/api-reference/webhooks/update-a-resthook-subscription"},{"title":"Activate a resthook subscription","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/resthook_subscriptions/activate","href":"/api-reference/webhooks/activate-a-resthook-subscription"}]},{"group":"Search \u0026 Match","pages":[{"title":"Create a document from raw data","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/documents/create_from_data","href":"/api-reference/search-\u0026-match/create-a-document-from-raw-data"},{"title":"Update a document's data","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/documents/{identifier}/update_data","href":"/api-reference/search-\u0026-match/update-a-documents-data"},{"title":"List occupation groups","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/occupation_groups","href":"/api-reference/search-\u0026-match/list-occupation-groups"},{"title":"Search through parsed resumes","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/resume_search","href":"/api-reference/search-\u0026-match/search-through-parsed-resumes"},{"title":"Get search result of specific resume","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/resume_search/details/{identifier}","href":"/api-reference/search-\u0026-match/get-search-result-of-specific-resume"},{"title":"Get the config for the logged in user's embeddable resume search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resume_search/config","href":"/api-reference/search-\u0026-match/get-the-config-for-the-logged-in-users-embeddable-resume-search-tool"},{"title":"Update the config for the logged in user's embeddable resume search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/resume_search/config","href":"/api-reference/search-\u0026-match/update-the-config-for-the-logged-in-users-embeddable-resume-search-tool"},{"title":"Create a signed URL for the embeddable resume search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/resume_search/embed","href":"/api-reference/search-\u0026-match/create-a-signed-url-for-the-embeddable-resume-search-tool"},{"title":"Match a single resume and job description","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resume_search/match","href":"/api-reference/search-\u0026-match/match-a-single-resume-and-job-description"},{"title":"Get job title suggestions based on provided job title(s)","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resume_search/suggestion_job_title","href":"/api-reference/search-\u0026-match/get-job-title-suggestions-based-on-provided-job-titles"},{"title":"Get skill suggestions based on provided skill(s)","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resume_search/suggestion_skill","href":"/api-reference/search-\u0026-match/get-skill-suggestions-based-on-provided-skills"},{"title":"Search through parsed job descriptions","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/job_description_search","href":"/api-reference/search-\u0026-match/search-through-parsed-job-descriptions"},{"title":"Get search result of specific job description","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/job_description_search/details/{identifier}","href":"/api-reference/search-\u0026-match/get-search-result-of-specific-job-description"},{"title":"Get the config for the logged in user's embeddable job description search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/job_description_search/config","href":"/api-reference/search-\u0026-match/get-the-config-for-the-logged-in-users-embeddable-job-description-search-tool"},{"title":"Update the config for the logged in user's embeddable job description search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/job_description_search/config","href":"/api-reference/search-\u0026-match/update-the-config-for-the-logged-in-users-embeddable-job-description-search-tool"},{"title":"Create a signed URL for the embeddable job description search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/job_description_search/embed","href":"/api-reference/search-\u0026-match/create-a-signed-url-for-the-embeddable-job-description-search-tool"},{"title":"Get list of all indexes","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/index","href":"/api-reference/search-\u0026-match/get-list-of-all-indexes"},{"title":"Create a new index","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/index","href":"/api-reference/search-\u0026-match/create-a-new-index"},{"title":"Delete an index","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/index/{name}","href":"/api-reference/search-\u0026-match/delete-an-index"},{"title":"Update an index","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/index/{name}","href":"/api-reference/search-\u0026-match/update-an-index"},{"title":"Get indexed documents for a specific index","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/index/{name}/documents","href":"/api-reference/search-\u0026-match/get-indexed-documents-for-a-specific-index"},{"title":"Index a new document","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/index/{name}/documents","href":"/api-reference/search-\u0026-match/index-a-new-document"},{"title":"Delete an indexed document","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/index/{name}/documents/{identifier}","href":"/api-reference/search-\u0026-match/delete-an-indexed-document"},{"title":"Re-index a document","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/index/{name}/documents/{identifier}/re_index","href":"/api-reference/search-\u0026-match/re-index-a-document"}]},{"group":"Deprecated End Points","pages":[{"title":"Get list of all collections","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/collections","href":"/api-reference/deprecated-end-points/get-list-of-all-collections"},{"title":"Create a collection","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/collections","href":"/api-reference/deprecated-end-points/create-a-collection"},{"title":"Get specific collection","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/collections/{identifier}","href":"/api-reference/deprecated-end-points/get-specific-collection"},{"title":"Delete a collection","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/collections/{identifier}","href":"/api-reference/deprecated-end-points/delete-a-collection"},{"title":"Update a collection","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/collections/{identifier}","href":"/api-reference/deprecated-end-points/update-a-collection"},{"title":"Create data field for a collection along with a new data point.","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/collections/{identifier}/create_data_field","href":"/api-reference/deprecated-end-points/create-data-field-for-a-collection-along-with-a-new-data-point"},{"title":"Get data field for a collection assosciated with a data point.","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/collections/{identifier}/fields/{datapoint_identifier}","href":"/api-reference/deprecated-end-points/get-data-field-for-a-collection-assosciated-with-a-data-point"},{"title":"Update data field for a collection assosciated with a data point.","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/collections/{identifier}/fields/{datapoint_identifier}","href":"/api-reference/deprecated-end-points/update-data-field-for-a-collection-assosciated-with-a-data-point"},{"title":"Get usage by collection","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/collections/{identifier}/usage","href":"/api-reference/deprecated-end-points/get-usage-by-collection"},{"title":"Get list of all data points","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/data_points","href":"/api-reference/deprecated-end-points/get-list-of-all-data-points"},{"title":"Create a data point","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/data_points","href":"/api-reference/deprecated-end-points/create-a-data-point"},{"title":"Get specific data point","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/data_points/{identifier}","href":"/api-reference/deprecated-end-points/get-specific-data-point"},{"title":"Delete a data point","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/data_points/{identifier}","href":"/api-reference/deprecated-end-points/delete-a-data-point"},{"title":"Update a data point","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/data_points/{identifier}","href":"/api-reference/deprecated-end-points/update-a-data-point"},{"title":"Get list of data point choices","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/data_point_choices","href":"/api-reference/deprecated-end-points/get-list-of-data-point-choices"},{"title":"Create a data point choice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/data_point_choices","href":"/api-reference/deprecated-end-points/create-a-data-point-choice"},{"title":"Get specific data point choice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/data_point_choices/{id}","href":"/api-reference/deprecated-end-points/get-specific-data-point-choice"},{"title":"Delete a data point choice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/data_point_choices/{id}","href":"/api-reference/deprecated-end-points/delete-a-data-point-choice"},{"title":"Update a data point choice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/data_point_choices/{id}","href":"/api-reference/deprecated-end-points/update-a-data-point-choice"},{"title":"Replace choices of a data point","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/data_point_choices/replace","href":"/api-reference/deprecated-end-points/replace-choices-of-a-data-point"},{"title":"List mappings","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mappings","href":"/api-reference/deprecated-end-points/list-mappings"},{"title":"Create a mapping","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/mappings","href":"/api-reference/deprecated-end-points/create-a-mapping"},{"title":"Get specific mapping","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mappings/{identifier}","href":"/api-reference/deprecated-end-points/get-specific-mapping"},{"title":"Delete specific mapping","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/mappings/{identifier}","href":"/api-reference/deprecated-end-points/delete-specific-mapping"},{"title":"Update specific mapping","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/mappings/{identifier}","href":"/api-reference/deprecated-end-points/update-specific-mapping"}]},{"group":"Document API - Splitting","pages":[]},{"group":"Document API - Extractor","pages":[]},{"group":"Organization API - Invitation","pages":[]}]},{"group":"Deprecated Versions","pages":[{"group":"v2 Endpoints (Legacy)","tag":"DEPRECATED","pages":[{"group":"Resume Parser","pages":[{"title":"Get list of all resumes","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resumes","href":"/api-reference/resume-parser/get-list-of-all-resumes"},{"title":"Upload a resume for parsing","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resumes","href":"/api-reference/resume-parser/upload-a-resume-for-parsing"},{"title":"Get parse results for a specific resume","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resumes/{identifier}","href":"/api-reference/resume-parser/get-parse-results-for-a-specific-resume"},{"title":"Delete a resume","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/resumes/{identifier}","href":"/api-reference/resume-parser/delete-a-resume"},{"title":"Update a resume's data","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/resumes/{identifier}","href":"/api-reference/resume-parser/update-a-resumes-data"}]},{"group":"Resume Redactor","pages":[{"title":"Get list of all redacted resumes","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/redacted_resumes","href":"/api-reference/resume-redactor/get-list-of-all-redacted-resumes"},{"title":"Upload a resume for redacting","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/redacted_resumes","href":"/api-reference/resume-redactor/upload-a-resume-for-redacting"},{"title":"Get redaction results for a specific resume","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/redacted_resumes/{identifier}","href":"/api-reference/resume-redactor/get-redaction-results-for-a-specific-resume"},{"title":"Delete a redacted resume","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/redacted_resumes/{identifier}","href":"/api-reference/resume-redactor/delete-a-redacted-resume"}]},{"group":"Invoice Extractor","pages":[{"title":"Get list of all invoices","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/invoices","href":"/api-reference/invoice-extractor/get-list-of-all-invoices"},{"title":"Upload an invoice for parsing","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/invoices","href":"/api-reference/invoice-extractor/upload-an-invoice-for-parsing"},{"title":"Get parse results for a specific invoice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/invoices/{identifier}","href":"/api-reference/invoice-extractor/get-parse-results-for-a-specific-invoice"},{"title":"Delete an invoice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/invoices/{identifier}","href":"/api-reference/invoice-extractor/delete-an-invoice"}]},{"group":"Job Description Parser","pages":[{"title":"Get list of all job descriptions","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/job_descriptions","href":"/api-reference/job-description-parser/get-list-of-all-job-descriptions"},{"title":"Upload a job description for parsing","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/job_descriptions","href":"/api-reference/job-description-parser/upload-a-job-description-for-parsing"},{"title":"Get job description results for a specific job description file","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/job_descriptions/{identifier}","href":"/api-reference/job-description-parser/get-job-description-results-for-a-specific-job-description-file"},{"title":"Delete a job description","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/job_descriptions/{identifier}","href":"/api-reference/job-description-parser/delete-a-job-description"},{"title":"Update a job description's data","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/job_descriptions/{identifier}","href":"/api-reference/job-description-parser/update-a-job-descriptions-data"}]},{"group":"Search \u0026 Match - Searching","pages":[{"title":"Search through parsed job descriptions","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/job_description_search","href":"/api-reference/search-\u0026-match--searching/search-through-parsed-job-descriptions"},{"title":"Get search result of specific job description","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/job_description_search/details/{identifier}","href":"/api-reference/search-\u0026-match--searching/get-search-result-of-specific-job-description"},{"title":"Search through parsed resumes","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resume_search","href":"/api-reference/search-\u0026-match--searching/search-through-parsed-resumes"},{"title":"Get search result of specific resume","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resume_search/details/{identifier}","href":"/api-reference/search-\u0026-match--searching/get-search-result-of-specific-resume"},{"title":"Match a single resume and job description","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resume_search/match","href":"/api-reference/search-\u0026-match--searching/match-a-single-resume-and-job-description"},{"title":"Get job title suggestions based on provided job title(s)","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resume_search/suggestion_job_title","href":"/api-reference/search-\u0026-match--searching/get-job-title-suggestions-based-on-provided-job-titles"},{"title":"Get skill suggestions based on provided skill(s)","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resume_search/suggestion_skill","href":"/api-reference/search-\u0026-match--searching/get-skill-suggestions-based-on-provided-skills"},{"title":"List occupation groups","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/occupation_groups","href":"/api-reference/search-\u0026-match--searching/list-occupation-groups"}]},{"group":"Search \u0026 Match - Embedding","pages":[{"title":"Get the config for the logged in user's embeddable job description search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/job_description_search/config","href":"/api-reference/search-\u0026-match--embedding/get-the-config-for-the-logged-in-users-embeddable-job-description-search-tool"},{"title":"Update the config for the logged in user's embeddable job description search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/job_description_search/config","href":"/api-reference/search-\u0026-match--embedding/update-the-config-for-the-logged-in-users-embeddable-job-description-search-tool"},{"title":"Create a signed URL for the embeddable job description search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/job_description_search/embed","href":"/api-reference/search-\u0026-match--embedding/create-a-signed-url-for-the-embeddable-job-description-search-tool"},{"title":"Get the config for the logged in user's embeddable resume search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resume_search/config","href":"/api-reference/search-\u0026-match--embedding/get-the-config-for-the-logged-in-users-embeddable-resume-search-tool"},{"title":"Update the config for the logged in user's embeddable resume search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/resume_search/config","href":"/api-reference/search-\u0026-match--embedding/update-the-config-for-the-logged-in-users-embeddable-resume-search-tool"},{"title":"Create a signed URL for the embeddable resume search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resume_search/embed","href":"/api-reference/search-\u0026-match--embedding/create-a-signed-url-for-the-embeddable-resume-search-tool"}]},{"group":"Search \u0026 Match - Indexing","pages":[{"title":"Get list of all indexes","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/index","href":"/api-reference/search-\u0026-match--indexing/get-list-of-all-indexes"},{"title":"Create a new index","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/index","href":"/api-reference/search-\u0026-match--indexing/create-a-new-index"},{"title":"Delete an index","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/index/{name}","href":"/api-reference/search-\u0026-match--indexing/delete-an-index"},{"title":"Update an index","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/index/{name}","href":"/api-reference/search-\u0026-match--indexing/update-an-index"},{"title":"Get indexed documents for a specific index","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/index/{name}/documents","href":"/api-reference/search-\u0026-match--indexing/get-indexed-documents-for-a-specific-index"},{"title":"Index a new document","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/index/{name}/documents","href":"/api-reference/search-\u0026-match--indexing/index-a-new-document"},{"title":"Delete an indexed document","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/index/{name}/documents/{identifier}","href":"/api-reference/search-\u0026-match--indexing/delete-an-indexed-document"}]},{"group":"Webhook API","pages":[{"title":"Get list of all resthook subscriptions","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resthook_subscriptions","href":"/api-reference/webhook-api/get-list-of-all-resthook-subscriptions"},{"title":"Create a resthook subscription","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resthook_subscriptions","href":"/api-reference/webhook-api/create-a-resthook-subscription"},{"title":"Get specific resthook subscription","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resthook_subscriptions/{id}","href":"/api-reference/webhook-api/get-specific-resthook-subscription"},{"title":"Delete a resthook subscription","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/resthook_subscriptions/{id}","href":"/api-reference/webhook-api/delete-a-resthook-subscription"},{"title":"Update a resthook subscription","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/resthook_subscriptions/{id}","href":"/api-reference/webhook-api/update-a-resthook-subscription"},{"title":"Activate a resthook subscription","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resthook_subscriptions/activate","href":"/api-reference/webhook-api/activate-a-resthook-subscription"}]}]}]}]},{"tab":"AI Integrations","pages":[{"title":"AI Integrations","href":"/integrations/mcp-connector"}]},{"tab":"Additional Resources","pages":[{"title":"Additional Resources","href":"/resources"}]}]},"basePath":"","title":"Update a document - Affinda Extract Documentation","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-DicSZcaX.js","dist-CIQkMg3R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-ClVdStUn.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","AssistantPageLink-ImrFS4Fy.js"]}