{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}
{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}
{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}
Usage
Get usage
Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both workspace and document_type.
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.
Optionally scope the report to a single workspace within the organization. Combine with document_type to scope to a single (workspace × document type) pair.
Uniquely identify a workspace.
Optionally scope the report to a single document type within the organization. Combine with workspace to scope to a single (workspace × document type) pair.
Uniquely identify a collection.
Inclusive end date of the report (YYYY-MM-DD). Defaults to today.
Response
Daily credits consumption for the requested scope.
Daily credits consumption for an organization over a date range, optionally scoped to a single workspace, a single document type, or a single (workspace × document type) pair.
Identifier of the scoped entity: the organization, workspace, or document type identifier. When scoped to a (workspace × document type) pair, it is the workspace and document type identifiers joined by a colon ({workspaceIdentifier}:{documentTypeIdentifier}).
Per-day breakdown. Days with zero usage are omitted.
Show child attributes
{"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":"#E8EEED","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":"#B09670","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":"6ac56a0f3afc16a603ad513a","collectionId":"7b08d586-aac3-44c0-9991-f40a6da86c49","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac56a0f3afc16a603ad513a"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae40b10dfc193c4660ad2a2","clientVersion":"0.0.4021","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":27},{"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":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"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}#navbar a[href*=\"app.affinda.com\"],#navbar a[href*=\"app.affinda.com\"] *,#navbar-primary-cta,#navbar-primary-cta *,a[href=\"https://app.affinda.com\"],a[href=\"https://app.affinda.com\"] *,span.text-white.z-10{color:#000!important}"}],"page":{"pagePath":"api-reference/usage/get-usage","slug":"/api-reference/usage/get-usage","pageMetadata":{"title":"Get usage","description":"Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both `workspace` and `document_type`.","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/usage","href":"/api-reference/usage/get-usage","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both \", _jsx(_components.code, {\n children: \"workspace\"\n }), \" and \", _jsx(_components.code, {\n children: \"document_type\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get usage","description":"Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both `workspace` and `document_type`.","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/usage","href":"/api-reference/usage/get-usage","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Usage"],"summary":"Get usage","operationId":"getUsage","description":"Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both `workspace` and `document_type`.","parameters":["3a6e3067-bfd3-4d44-ad19-b546d8f2e717","a4aab449-f2c4-4b96-ae91-e3bebae2febf","1942a146-5c70-490b-a49e-e27310396a98","e07df3d8-0d94-46f3-a296-708f903ee4bc","fa7fdcb9-c79d-4860-93a8-c7159d3eda80"],"responses":{"200":"80f99494-7727-43d3-9fc2-de5be59ecffe","400":"e523e9b7-0d0b-4be6-a329-d10e14789bbf","401":"dd8297e8-e538-4c59-8567-33c64e575c86","default":"b68f04bb-5dd2-45f1-9efa-82aced031aa1"},"method":"get","type":"path","servers":["22b901d7-22af-42f1-9666-f9832a1fc626"],"security":["245b976a-4220-4978-9788-de711007412b"],"path":"/v3/usage","baseUrlOptions":["https://{region}.affinda.com"],"title":"Get usage","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3a6e3067-bfd3-4d44-ad19-b546d8f2e717":{"in":"query","name":"organization","required":true,"schema":{"type":"string","description":"Organization to report usage for. The caller must be an admin or owner.\nUniquely identify an organization.","example":"mEFayXdO","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"Organization to report usage for. The caller must be an admin or owner."},"a4aab449-f2c4-4b96-ae91-e3bebae2febf":{"in":"query","name":"workspace","schema":{"type":"string","description":"Optionally scope the report to a single workspace within the organization. Combine with `document_type` to scope to a single (workspace × document type) pair.\nUniquely identify a workspace.","example":"mEFayXdO","uniqueKey":"","typeLabel":"string"},"description":"Optionally scope the report to a single workspace within the organization. Combine with `document_type` to scope to a single (workspace × document type) pair."},"1942a146-5c70-490b-a49e-e27310396a98":{"in":"query","name":"document_type","schema":{"type":"string","description":"Optionally scope the report to a single document type within the organization. Combine with `workspace` to scope to a single (workspace × document type) pair.\nUniquely identify a collection.","example":"mEFayXdO","uniqueKey":"","typeLabel":"string"},"description":"Optionally scope the report to a single document type within the organization. Combine with `workspace` to scope to a single (workspace × document type) pair."},"e07df3d8-0d94-46f3-a296-708f903ee4bc":{"in":"query","name":"start","schema":{"type":"string","format":"date","description":"Inclusive start date of the report (YYYY-MM-DD). Defaults to 365 days before `end`.","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"Inclusive start date of the report (YYYY-MM-DD). Defaults to 365 days before `end`."},"fa7fdcb9-c79d-4860-93a8-c7159d3eda80":{"in":"query","name":"end","schema":{"type":"string","format":"date","description":"Inclusive end date of the report (YYYY-MM-DD). Defaults to today.","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"Inclusive end date of the report (YYYY-MM-DD). Defaults to today."}},"responses":{"80f99494-7727-43d3-9fc2-de5be59ecffe":{"description":"Daily credits consumption for the requested scope.","content":{"application/json":{"schema":{"type":"object","description":"Daily credits consumption for an organization over a date range, optionally scoped to a single workspace, a single document type, or a single (workspace × document type) pair.","required":["scope","scopeIdentifier","start","end","total","items"],"properties":{"scope":{"type":"string","description":"What the usage was scoped to.","enum":["organization","workspace","documentType","workspaceAndDocumentType"],"isRequired":true,"uniqueKey":"scope","typeLabel":"enum\u003cstring>"},"scopeIdentifier":{"type":"string","description":"Identifier of the scoped entity: the organization, workspace, or document type identifier. When scoped to a (workspace × document type) pair, it is the workspace and document type identifiers joined by a colon (`{workspaceIdentifier}:{documentTypeIdentifier}`).","isRequired":true,"uniqueKey":"scopeIdentifier","typeLabel":"string"},"start":{"type":"string","format":"date","description":"Inclusive start of the reported period (YYYY-MM-DD).","example":"2025-04-01","isRequired":true,"uniqueKey":"start","typeLabel":"string\u003cdate>"},"end":{"type":"string","format":"date","description":"Inclusive end of the reported period (YYYY-MM-DD).","example":"2025-04-30","isRequired":true,"uniqueKey":"end","typeLabel":"string\u003cdate>"},"total":{"type":"integer","description":"Total credits consumed over the period.","example":4320,"isRequired":true,"uniqueKey":"total","typeLabel":"integer"},"items":{"type":"array","description":"Per-day breakdown. Days with zero usage are omitted.","items":{"type":"object","description":"Daily credits consumption for a single date in the requested period.","required":["date","count"],"properties":{"date":{"type":"string","format":"date","description":"The day this usage was recorded against, in YYYY-MM-DD.","example":"2025-04-15","isRequired":true,"uniqueKey":"\\items.items.[INDEX].date","typeLabel":"string\u003cdate>"},"count":{"type":"integer","description":"Credits consumed on this day.","example":123,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].count","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"scope":"organization","scopeIdentifier":"\u003cstring>","start":"2025-04-01","end":"2025-04-30","total":4320,"items":[{"date":"2025-04-15","count":123}]}}},"exampleType":"generated"}},"exampleType":"generated"},"e523e9b7-0d0b-4be6-a329-d10e14789bbf":{"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"},"dd8297e8-e538-4c59-8567-33c64e575c86":{"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"},"b68f04bb-5dd2-45f1-9efa-82aced031aa1":{"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":"Get usage - Affinda Extract Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T03:11:07.438Z","originalFileLocation":"api-reference/usage/get-usage.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=\"Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both workspace and document_type.\">\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=\"Get usage - Affinda Extract Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both workspace and document_type.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Affinda\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.affinda.com/api-reference/usage/get-usage\">\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=\"Get usage - Affinda Extract Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both workspace and document_type.\">\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/usage/get-usage\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/usage/get-usage.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/usage/get-usage#webpage\",\"url\":\"https://docs.affinda.com/api-reference/usage/get-usage\",\"name\":\"Get usage\",\"description\":\"Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both workspace and document_type.\",\"dateModified\":\"2026-10-30T03:11:07.438Z\",\"isPartOf\":{\"@id\":\"https://docs.affinda.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.affinda.com/api-reference/usage/get-usage#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.affinda.com/api-reference/usage/get-usage#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\":\"Get usage\",\"item\":\"https://docs.affinda.com/api-reference/usage/get-usage\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.affinda.com/api-reference/usage/get-usage#apireference\",\"headline\":\"Get usage\",\"name\":\"Get usage\",\"description\":\"Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both workspace and document_type.\",\"url\":\"https://docs.affinda.com/api-reference/usage/get-usage\",\"mainEntityOfPage\":{\"@id\":\"https://docs.affinda.com/api-reference/usage/get-usage#webpage\"},\"image\":\"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/68ae96fe8f3fdbbe0ae04c73_Affinda%20Open%20Graph%20image%20for%20website%20previews.png\",\"dateModified\":\"2026-10-30T03:11:07.438Z\",\"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","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","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","description":"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","description":"Returns your 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"}]}]},"title":"Get usage - Affinda Extract Documentation","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-m8-xYP3Y.js","dist-1ms6tsT-.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-DMKzROTp.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","AssistantPageLink-Ke9xIMFx.js"]}