client.jobs.usage (period_start / period_end as dates)
GET
/v1/usage/overview
HTTP only
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"NDI Platform API","description":"Document intelligence platform API — parse, split, classify, extract, and ground information from any document.","colors":{"primary":"#111111","light":"#737373","dark":"#E5E5E5"},"favicon":"https://mintcdn.com/nace-ai/RoMHjaneGKdnwusm/favicon.png?fit=max\u0026auto=format\u0026n=RoMHjaneGKdnwusm\u0026q=85\u0026s=9b5d6ee38930c58bd4cc7e964e66a5b0","api":{"openapi":"openapi.json","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl"],"autogenerate":true}},"appearance":{"default":"system"},"background":{"decoration":"gradient"},"footer":{"socials":{}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"dark","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nace-ai","hasAudioNarration":false,"actualSubdomain":"nace-ai","customDomains":["docs.ndi.nace.ai"],"gitSource":{"type":"github","owner":"yeranaceai","repo":"ndi-service-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"ee89f5ee-8923-4ea0-9680-31a30151f1d8","liveDeploymentHistoryId":"6ad7fd83407fbf2de0ada1da","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad7fd83407fbf2de0ada1da"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ad7fd83407fbf2de0ada1da","clientVersion":"0.0.3908","searchFilterCounts":[{"language":"default","tag":"API Reference","count":102},{"language":"default","tag":"Documentation","count":42},{"language":"default","tag":"SDKs","count":34},{"language":"default","tag":"Core methods","count":26},{"language":"default","tag":"Workspaces and files","count":25},{"language":"default","tag":"Guides","count":24},{"language":"default","tag":"Catalog","count":22},{"language":"default","tag":"Tools and search","count":17},{"language":"default","tag":"Jobs and usage","count":16},{"language":"default","tag":"Concepts","count":12}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"editor-private-page-search","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":"teamspace","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/usage","slug":"/api-reference/usage","pageMetadata":{"title":"Usage","description":"Processing-unit rollups","href":"/api-reference/usage"},"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: \"Processing-unit rollups\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Table}=_components;if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/concepts/units`,children:`Processing units`}),` and `,_jsx(_components.a,{href:`/guides/jobs`,children:`Jobs`}),`.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Method`}),_jsx(_components.th,{children:`Path`}),_jsx(_components.th,{children:`SDK`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/usage`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`client.jobs.usage`}),` (`,_jsx(_components.code,{children:`period_start`}),` / `,_jsx(_components.code,{children:`period_end`}),` as dates)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/usage/overview`})}),_jsx(_components.td,{children:`HTTP only`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Usage","description":"Processing-unit rollups","href":"/api-reference/usage"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"nace-ai","siteName":"NDI Platform API","title":"Usage - NDI Platform API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-03T00:24:54.594Z","originalFileLocation":"api-reference/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=\"Processing-unit rollups\">\u003cmeta data-mint-head name=\"application-name\" content=\"NDI Platform API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nace-ai/ON_ODtu5ozmA-6iq/_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/nace-ai/ON_ODtu5ozmA-6iq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nace-ai/ON_ODtu5ozmA-6iq/_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/nace-ai/ON_ODtu5ozmA-6iq/_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/nace-ai/ON_ODtu5ozmA-6iq/_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/nace-ai/ON_ODtu5ozmA-6iq/_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/nace-ai/ON_ODtu5ozmA-6iq/_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/nace-ai/ON_ODtu5ozmA-6iq/_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/nace-ai/ON_ODtu5ozmA-6iq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Usage - NDI Platform API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Processing-unit rollups\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"NDI Platform API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ndi.nace.ai/api-reference/usage\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Usage - NDI Platform API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Processing-unit rollups\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/nace-ai/ON_ODtu5ozmA-6iq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"NDI Platform API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111111\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ndi.nace.ai/api-reference/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.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ndi.nace.ai/#organization\",\"name\":\"NDI Platform API\",\"url\":\"https://docs.ndi.nace.ai\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ndi.nace.ai#website\",\"name\":\"NDI Platform API\",\"url\":\"https://docs.ndi.nace.ai\",\"publisher\":{\"@id\":\"https://docs.ndi.nace.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ndi.nace.ai/api-reference/usage#webpage\",\"url\":\"https://docs.ndi.nace.ai/api-reference/usage\",\"name\":\"Usage\",\"description\":\"Processing-unit rollups\",\"dateModified\":\"2026-09-03T00:24:54.594Z\",\"isPartOf\":{\"@id\":\"https://docs.ndi.nace.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ndi.nace.ai/api-reference/usage#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ndi.nace.ai/api-reference/usage#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Jobs and usage\",\"item\":\"https://docs.ndi.nace.ai/api-reference/jobs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Usage\",\"item\":\"https://docs.ndi.nace.ai/api-reference/usage\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.ndi.nace.ai/api-reference/usage#article\",\"headline\":\"Usage\",\"name\":\"Usage\",\"description\":\"Processing-unit rollups\",\"url\":\"https://docs.ndi.nace.ai/api-reference/usage\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ndi.nace.ai/api-reference/usage#webpage\"},\"dateModified\":\"2026-09-03T00:24:54.594Z\",\"publisher\":{\"@id\":\"https://docs.ndi.nace.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ndi.nace.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"NDI Platform API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"NDI Platform API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Conventions","pages":[{"title":"API conventions","href":"/api-reference/overview"}]},{"group":"Granular operations","pages":[{"title":"Uploads","href":"/api-reference/uploads"},{"title":"Document operations","href":"/api-reference/document-operations"},{"title":"create_upload","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/uploads","href":"/api-reference/document-operations/create_upload"},{"title":"parse","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/parse","href":"/api-reference/document-operations/parse"},{"title":"split","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/split","href":"/api-reference/document-operations/split"},{"title":"classify","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/classify","href":"/api-reference/document-operations/classify"},{"title":"extract","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/extract","href":"/api-reference/document-operations/extract"},{"title":"validate_extract_schema","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/extract/schema-validation","href":"/api-reference/document-operations/validate_extract_schema"},{"title":"ground","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/ground","href":"/api-reference/document-operations/ground"}]},{"group":"Decisions","pages":[{"title":"Drex (Decision Model)","href":"/api-reference/systemone"},{"title":"evaluate_systemone","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/systemone","href":"/api-reference/systemone/evaluate_systemone"}]},{"group":"Catalog","pages":[{"title":"Domains","href":"/api-reference/domains"},{"title":"Access labels","href":"/api-reference/access-labels"},{"title":"Extraction schemas","href":"/api-reference/extraction-schemas"},{"title":"list_domains","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/domains","href":"/api-reference/domains/list_domains"},{"title":"generate_domain","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/domains/generate","href":"/api-reference/domains/generate_domain"},{"title":"suggest_domain_description","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/domains/suggest-description","href":"/api-reference/domains/suggest_domain_description"},{"title":"create_domain","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/domains","href":"/api-reference/domains/create_domain"},{"title":"get_domain","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/domains/{domain_id}","href":"/api-reference/domains/get_domain"},{"title":"update_domain","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/domains/{domain_id}","href":"/api-reference/domains/update_domain"},{"title":"publish_domain","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/domains/{domain_id}/publish","href":"/api-reference/domains/publish_domain"},{"title":"list_access_labels","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/access-labels","href":"/api-reference/access-labels/list_access_labels"},{"title":"create_access_label","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/access-labels","href":"/api-reference/access-labels/create_access_label"},{"title":"get_access_label","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/access-labels/{access_label_id}","href":"/api-reference/access-labels/get_access_label"},{"title":"update_access_label","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/access-labels/{access_label_id}","href":"/api-reference/access-labels/update_access_label"},{"title":"delete_access_label","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/access-labels/{access_label_id}","href":"/api-reference/access-labels/delete_access_label"},{"title":"list_extraction_schemas","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/extraction-schemas","href":"/api-reference/extraction-schemas/list_extraction_schemas"},{"title":"create_extraction_schema","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/extraction-schemas","href":"/api-reference/extraction-schemas/create_extraction_schema"},{"title":"get_extraction_schema","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/extraction-schemas/{schema_id}","href":"/api-reference/extraction-schemas/get_extraction_schema"},{"title":"delete_extraction_schema","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/extraction-schemas/{schema_id}","href":"/api-reference/extraction-schemas/delete_extraction_schema"},{"title":"list_extraction_schema_versions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/extraction-schemas/{schema_id}/versions","href":"/api-reference/extraction-schemas/list_extraction_schema_versions"},{"title":"create_extraction_schema_version","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/extraction-schemas/{schema_id}/versions","href":"/api-reference/extraction-schemas/create_extraction_schema_version"},{"title":"get_extraction_schema_version","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/extraction-schemas/{schema_id}/versions/{version}","href":"/api-reference/extraction-schemas/get_extraction_schema_version"}]},{"group":"Workspaces and files","pages":[{"title":"Workspaces","href":"/api-reference/workspaces"},{"title":"Files","href":"/api-reference/files"},{"title":"create_workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces","href":"/api-reference/workspaces/create_workspace"},{"title":"list_workspaces","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces","href":"/api-reference/workspaces/list_workspaces"},{"title":"get_workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces/{workspace_id}","href":"/api-reference/workspaces/get_workspace"},{"title":"update_workspace","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/workspaces/{workspace_id}","href":"/api-reference/workspaces/update_workspace"},{"title":"get_workspace_stats","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces/{workspace_id}/stats","href":"/api-reference/workspaces/get_workspace_stats"},{"title":"delete_workspace","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/workspaces/{workspace_id}","href":"/api-reference/workspaces/delete_workspace"},{"title":"create_upload_grant","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/upload-grants","href":"/api-reference/files/create_upload_grant"},{"title":"upload_file","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/files","href":"/api-reference/files/upload_file"},{"title":"list_files","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces/{workspace_id}/files","href":"/api-reference/files/list_files"},{"title":"get_file","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces/{workspace_id}/files/{file_id}","href":"/api-reference/files/get_file"},{"title":"get_file_metadata","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces/{workspace_id}/files/{file_id}/metadata","href":"/api-reference/files/get_file_metadata"},{"title":"get_file_output","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces/{workspace_id}/files/{file_id}/outputs/{output_id}","href":"/api-reference/files/get_file_output"},{"title":"list_output_members","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces/{workspace_id}/files/{file_id}/outputs/{output_id}/members","href":"/api-reference/files/list_output_members"},{"title":"get_file_versions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces/{workspace_id}/files/{file_id}/versions","href":"/api-reference/files/get_file_versions"},{"title":"replace_file","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/workspaces/{workspace_id}/files/{file_id}","href":"/api-reference/files/replace_file"},{"title":"delete_file","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/workspaces/{workspace_id}/files/{file_id}","href":"/api-reference/files/delete_file"},{"title":"create_upload_session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/upload-sessions","href":"/api-reference/files/create_upload_session"},{"title":"upload_session_part","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/workspaces/{workspace_id}/upload-sessions/{session_id}/parts/{part_number}","href":"/api-reference/files/upload_session_part"},{"title":"get_upload_session","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces/{workspace_id}/upload-sessions/{session_id}","href":"/api-reference/files/get_upload_session"},{"title":"complete_upload_session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/upload-sessions/{session_id}/complete","href":"/api-reference/files/complete_upload_session"},{"title":"abort_upload_session","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/workspaces/{workspace_id}/upload-sessions/{session_id}","href":"/api-reference/files/abort_upload_session"},{"title":"get_artifact_content","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces/{workspace_id}/artifacts/content","href":"/api-reference/artifacts/get_artifact_content"},{"title":"get_artifact_rows","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workspaces/{workspace_id}/artifacts/rows","href":"/api-reference/artifacts/get_artifact_rows"}]},{"group":"Ingestion and graph","pages":[{"title":"Ingestion","href":"/api-reference/ingestion"},{"title":"Knowledge graph build","href":"/api-reference/knowledge-graph"},{"title":"ingest","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/ingestions","href":"/api-reference/ingestion/ingest"},{"title":"reconcile","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/reconciliations","href":"/api-reference/ingestion/reconcile"},{"title":"build_knowledge_graph","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/knowledge-graph/builds","href":"/api-reference/knowledge-graph/build_knowledge_graph"}]},{"group":"Tools and search","pages":[{"title":"File tools","href":"/api-reference/file-tools"},{"title":"Fact and deep search (deprecated)","href":"/api-reference/intelligent-search"},{"title":"Filtered search (deprecated)","href":"/api-reference/filtered-search"},{"title":"Journal-entry testing","href":"/api-reference/je-testing"},{"title":"Ledger understanding","href":"/api-reference/ledger-understanding"},{"title":"Automatic search","href":"/api-reference/automatic-search"},{"title":"QA","href":"/api-reference/qa"},{"title":"folder_metadata","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/tools/folder-metadata","href":"/api-reference/tools/folder_metadata"},{"title":"file_metadata","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/tools/file-metadata","href":"/api-reference/tools/file_metadata"},{"title":"qa_file","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/tools/qa-file","href":"/api-reference/tools/qa_file"},{"title":"query_tables","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/tools/query-tables","href":"/api-reference/tools/query_tables"},{"title":"deep_search","deprecated":true,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/deep-search","href":"/api-reference/intelligent-search/deep_search"},{"title":"fact_search","deprecated":true,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/fact-search","href":"/api-reference/intelligent-search/fact_search"},{"title":"filtered_search","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/filtered-search","href":"/api-reference/filtered-search/filtered_search"},{"title":"je_testing","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/je-testing","href":"/api-reference/je-testing/je_testing"},{"title":"automatic_search","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/automatic-search","href":"/api-reference/intelligent-search/automatic_search"},{"title":"qa","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workspaces/{workspace_id}/qa","href":"/api-reference/intelligent-search/qa"}]},{"group":"Jobs and usage","pages":[{"title":"Jobs","description":"Lifecycle, events, cancel, request echo, delete, and artifacts","href":"/api-reference/jobs"},{"title":"Usage","href":"/api-reference/usage"},{"title":"list_jobs","description":"List jobs for the authenticated tenant, newest first. Cost class: fast.\n\n``workspace_id`` narrows to workspace-scoped jobs; omitting it returns\ndocument-operation jobs too. ``kind`` is the idiomatic way to list all\ningestion runs without a dedicated resource.\n\nPagination is keyset on ``(created_at, id)`` — OFFSET would silently miss\nor duplicate rows when new jobs arrive between pages.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/jobs","href":"/api-reference/operations/list_jobs"},{"title":"get_job","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/jobs/{job_id}","href":"/api-reference/operations/get_job"},{"title":"update_job","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/jobs/{job_id}","href":"/api-reference/operations/update_job"},{"title":"delete_job","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/jobs/{job_id}","href":"/api-reference/operations/delete_job"},{"title":"get_job_request","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/jobs/{job_id}/request","href":"/api-reference/operations/get_job_request"},{"title":"cancel_job","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/jobs/{job_id}/cancel","href":"/api-reference/operations/cancel_job"},{"title":"stream_job_events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/jobs/{job_id}/events","href":"/api-reference/operations/stream_job_events"},{"title":"get_ground_crop_content","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/jobs/{job_id}/ground-crops/{artifact_ref}","href":"/api-reference/operations/get_ground_crop_content"},{"title":"get_ground_transcript_content","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/jobs/{job_id}/ground-transcript/{artifact_ref}","href":"/api-reference/operations/get_ground_transcript_content"},{"title":"get_parse_transcript_content","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/jobs/{job_id}/parse-transcript/{artifact_ref}","href":"/api-reference/operations/get_parse_transcript_content"},{"title":"get_converted_pdf_content","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/jobs/{job_id}/converted-pdf/{artifact_ref}","href":"/api-reference/operations/get_converted_pdf_content"},{"title":"get_spreadsheet_cell_map_content","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/jobs/{job_id}/spreadsheet-cell-maps/{artifact_ref}","href":"/api-reference/operations/get_spreadsheet_cell_map_content"},{"title":"get_usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage","href":"/api-reference/operations/get_usage"},{"title":"get_usage_overview","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/overview","href":"/api-reference/operations/get_usage_overview"}]},{"group":"Partners","pages":[{"title":"Tenants","href":"/api-reference/tenants"},{"title":"list_tenants","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tenants","href":"/api-reference/tenants/list_tenants"},{"title":"put_tenant","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/tenants/{external_ref}","href":"/api-reference/tenants/put_tenant"},{"title":"get_tenant","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tenants/{external_ref}","href":"/api-reference/tenants/get_tenant"},{"title":"delete_tenant","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/tenants/{external_ref}","href":"/api-reference/tenants/delete_tenant"}]}]},{"tab":"SDKs","versions":[{"version":"Python","groups":[{"group":"Get started","pages":[{"title":"Python SDK","href":"/sdks/python"}]},{"group":"Core methods","pages":[{"title":"Upload","href":"/sdks/python/upload"},{"title":"Parse","href":"/sdks/python/parse"},{"title":"Extract","href":"/sdks/python/extract"},{"title":"Split","href":"/sdks/python/split"},{"title":"Classify","href":"/sdks/python/classify"},{"title":"Ground","href":"/sdks/python/ground"},{"title":"Workspaces","href":"/sdks/python/workspaces"},{"title":"Deep search (deprecated)","href":"/sdks/python/search"},{"title":"Journal-entry testing","href":"/sdks/python/je-testing"},{"title":"Ledger understanding","href":"/sdks/python/ledger-understanding"},{"title":"Automatic search","href":"/sdks/python/automatic-search"},{"title":"QA","href":"/sdks/python/qa"},{"title":"Drex (Decision Model)","href":"/sdks/python/systemone"}]},{"group":"Async and utilities","pages":[{"title":"Async client","href":"/sdks/python/async"},{"title":"Job management","href":"/sdks/python/job-management"},{"title":"Error handling","href":"/sdks/python/error-handling"}]}]},{"version":"TypeScript","pages":[{"title":"TypeScript","href":"/sdks/typescript"}]}]}]},"title":"Usage - NDI Platform API","buildId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","deploymentId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","dynamics":[],"chunks":[]}