Given a document and an arbitrary user JSON schema, fill the schema's
fields from the document and cite where each value came from.
url
string | null
HTTP(S) URL of the document to extract from. PHI-enabled keys must use the file-upload route instead.
schema
Schema · object | null
JSON Schema describing the fields to extract; field descriptions are instructions the extractor follows. Required unless auto_schema is true.
strict
boolean
default:true
What happens to a value whose citation cannot be verified against the document. true (default): the value is nulled out and its path listed in ungrounded_fields, so a fabricated value never reaches you. false: the value is kept but still flagged in ungrounded_fields.
auto_schema
boolean
default:false
Set true (and omit schema) to have a schema designed from the document first, then filled with the same grounded extraction. The schema used is returned in generated_schema.
extract_images
boolean
default:true
Include figures from the parse stage in the extraction context. Set false to extract from text and tables only.
include_ocr_text
boolean
default:false
false (default): response unchanged. true: additionally return ocr_text — the whole parsed document as a single text string, concatenated in reading order (the same text POST /v1/parse returns as content).
Response
Successful Response
values
Values · object
required
evidence
Evidence · object
required
Show child attributes
page_count
integer
required
ungrounded_fields
string[]
generated_schema
Generated Schema · object | null
usage
BillingUsage · object | null
What this request charged, in credits (plan 078 D6).
Present only on responses whose request was actually charged — absent
(never null) on unbilled lanes (demo, legacy-PHI ledger) so pre-credits
response shapes stay byte-identical. credits = pages × credits_per_page
at the v1 card: parse 1.0, schema extract 4.0 all-in.
Show child attributes
ocr_text
string | null
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hanji","description":"Parse documents into structured data.","colors":{"primary":"#0c0c0c","light":"#bad9f9","dark":"#0c0c0c"},"logo":{"light":"https://mintcdn.com/youlearn-b6958d02/Jy2a4ZjGgDJm0OsT/logo/light.svg?fit=max\u0026auto=format\u0026n=Jy2a4ZjGgDJm0OsT\u0026q=85\u0026s=04213e4d86750738bd50b582e537d2f0","dark":"https://mintcdn.com/youlearn-b6958d02/Jy2a4ZjGgDJm0OsT/logo/dark.svg?fit=max\u0026auto=format\u0026n=Jy2a4ZjGgDJm0OsT\u0026q=85\u0026s=370d162c81e2d402f59f68acea82d58c","href":"https://hanji.dev"},"favicon":"https://mintcdn.com/youlearn-b6958d02/Jy2a4ZjGgDJm0OsT/favicon.png?fit=max\u0026auto=format\u0026n=Jy2a4ZjGgDJm0OsT\u0026q=85\u0026s=49c5b072151a07aebb3757e4c2ccb387","api":{"playground":{"display":"interactive"}},"appearance":{"default":"light","strict":true},"background":{},"navbar":{"links":[{"href":"https://hanji.dev/pricing","label":"Pricing"},{"href":"https://hanji.dev/login","label":"Login"}],"primary":{"type":"button","label":"Get started","href":"https://hanji.dev/signup"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"youlearn-b6958d02","hasAudioNarration":false,"actualSubdomain":"youlearn-b6958d02","customDomains":["docs.hanji.dev"],"gitSource":{"type":"github","owner":"youlearn-ai","repo":"extract","deployBranch":"main","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae9558fe37977b6234dee40:success","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Async batch","count":8},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Schema extraction","count":2},{"language":"default","tag":"Parse (sync)","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@layer base{a.card,.card.card{transition:background-color 150ms ease}a.card:hover,.card.card:hover{border-color:rgb(3 7 18 / 0.1)!important;background-color:rgb(3 7 18 / 0.04)!important}.dark a.card:hover,.dark .card.card:hover{border-color:rgb(255 255 255 / 0.1)!important;background-color:rgb(255 255 255 / 0.06)!important}}"}]}
{"page":{"pagePath":"api-reference/v1/fill-a-schema-from-a-document-by-url","slug":"/api-reference/v1/fill-a-schema-from-a-document-by-url","pageMetadata":{"title":"Fill a schema from a document by URL","description":"Fill an arbitrary user JSON schema from a document URL, with citations.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/extract/schema","href":"/api-reference/v1/fill-a-schema-from-a-document-by-url","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Fill an arbitrary user JSON schema from a document URL, with citations.\"\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":"Fill a schema from a document by URL","description":"Fill an arbitrary user JSON schema from a document URL, with citations.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/extract/schema","href":"/api-reference/v1/fill-a-schema-from-a-document-by-url","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["v1"],"summary":"Fill a schema from a document by URL","description":"Fill an arbitrary user JSON schema from a document URL, with citations.","operationId":"extract_schema_v1","requestBody":"59b7345d-5c3a-457e-8b08-a14095a384b8","responses":{"200":"02c493de-b154-4b3b-866a-72dc85808803","422":"087cbde8-9906-46f6-b6a2-c0c98a6a469f"},"security":["17eeecf0-4777-419a-8a17-579d26a34ec6"],"method":"post","type":"path","servers":["dd30c128-e109-412d-8b2e-00d772db84e5"],"path":"/v1/extract/schema","baseUrlOptions":["https://api.hanji.dev"],"title":"Fill a schema from a document by URL","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"url":{"oneOf":[{"type":"string","title":"Url","description":"HTTP(S) URL of the document to extract from. PHI-enabled keys must use the file-upload route instead.","uniqueKey":"url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Url","description":"HTTP(S) URL of the document to extract from. PHI-enabled keys must use the file-upload route instead.","uniqueKey":"url.oneOf.1","typeLabel":"null"}],"uniqueKey":"url","typeLabel":"string | null"},"schema":{"oneOf":[{"type":"object","title":"Schema","description":"JSON Schema describing the fields to extract; field descriptions are instructions the extractor follows. Required unless auto_schema is true.","additionalProperties":true,"uniqueKey":"schema.oneOf.0","typeLabel":"Schema · object"},{"type":"null","title":"Schema","description":"JSON Schema describing the fields to extract; field descriptions are instructions the extractor follows. Required unless auto_schema is true.","uniqueKey":"schema.oneOf.1","typeLabel":"null"}],"uniqueKey":"schema","typeLabel":"Schema · object | null"},"strict":{"type":"boolean","title":"Strict","description":"What happens to a value whose citation cannot be verified against the document. true (default): the value is nulled out and its path listed in ungrounded_fields, so a fabricated value never reaches you. false: the value is kept but still flagged in ungrounded_fields.","default":true,"uniqueKey":"strict","typeLabel":"boolean"},"auto_schema":{"type":"boolean","title":"Auto Schema","description":"Set true (and omit schema) to have a schema designed from the document first, then filled with the same grounded extraction. The schema used is returned in generated_schema.","default":false,"uniqueKey":"auto_schema","typeLabel":"boolean"},"extract_images":{"type":"boolean","title":"Extract Images","description":"Include figures from the parse stage in the extraction context. Set false to extract from text and tables only.","default":true,"uniqueKey":"extract_images","typeLabel":"boolean"},"include_ocr_text":{"type":"boolean","title":"Include Ocr Text","description":"false (default): response unchanged. true: additionally return `ocr_text` — the whole parsed document as a single text string, concatenated in reading order (the same text POST /v1/parse returns as `content`).","default":false,"uniqueKey":"include_ocr_text","typeLabel":"boolean"}},"type":"object","title":"SchemaExtractRequest","description":"Input to a schema-extraction request.\n\nGiven a document and an arbitrary user JSON schema, fill the schema's\nfields from the document and cite where each value came from.","uniqueKey":"","typeLabel":"SchemaExtractRequest · object"},"examples":{"Example":{"title":"Example","value":{"url":"\u003cstring>","schema":{},"strict":true,"auto_schema":false,"extract_images":true,"include_ocr_text":false}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"02c493de-b154-4b3b-866a-72dc85808803":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"values":{"additionalProperties":true,"type":"object","title":"Values","isRequired":true,"uniqueKey":"values","typeLabel":"Values · object"},"evidence":{"additionalProperties":{"items":{"properties":{"page":{"type":"integer","title":"Page","isRequired":true,"uniqueKey":"evidence.additionalProperties.items.[INDEX].page","typeLabel":"integer"},"text":{"type":"string","title":"Text","isRequired":true,"uniqueKey":"evidence.additionalProperties.items.[INDEX].text","typeLabel":"string"},"bbox":{"oneOf":[{"type":"array","items":{"type":"number","uniqueKey":"evidence.additionalProperties.items.[INDEX].bbox.oneOf.0.items.[INDEX]","typeLabel":"number"},"title":"Bbox","uniqueKey":"evidence.additionalProperties.items.[INDEX].bbox.oneOf.0","typeLabel":"number[]"},{"type":"null","title":"Bbox","uniqueKey":"evidence.additionalProperties.items.[INDEX].bbox.oneOf.1","typeLabel":"null"}],"uniqueKey":"evidence.additionalProperties.items.[INDEX].bbox","typeLabel":"number[] | null"},"confidence":{"oneOf":[{"type":"number","title":"Confidence","uniqueKey":"evidence.additionalProperties.items.[INDEX].confidence.oneOf.0","typeLabel":"number"},{"type":"null","title":"Confidence","uniqueKey":"evidence.additionalProperties.items.[INDEX].confidence.oneOf.1","typeLabel":"null"}],"uniqueKey":"evidence.additionalProperties.items.[INDEX].confidence","typeLabel":"number | null"},"needs_review":{"type":"boolean","title":"Needs Review","default":false,"uniqueKey":"evidence.additionalProperties.items.[INDEX].needs_review","typeLabel":"boolean"},"suggested_value":{"oneOf":[{"type":"string","title":"Suggested Value","uniqueKey":"evidence.additionalProperties.items.[INDEX].suggested_value.oneOf.0","typeLabel":"string"},{"type":"null","title":"Suggested Value","uniqueKey":"evidence.additionalProperties.items.[INDEX].suggested_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"evidence.additionalProperties.items.[INDEX].suggested_value","typeLabel":"string | null"}},"type":"object","required":["page","text"],"title":"FieldEvidence","description":"One grounding citation for an extracted value.","uniqueKey":"evidence.additionalProperties.items.[INDEX]","typeLabel":"FieldEvidence · object"},"type":"array","uniqueKey":"evidence.additionalProperties","typeLabel":"FieldEvidence · object[]"},"type":"object","title":"Evidence","isRequired":true,"uniqueKey":"evidence","typeLabel":"Evidence · object"},"page_count":{"type":"integer","title":"Page Count","isRequired":true,"uniqueKey":"page_count","typeLabel":"integer"},"ungrounded_fields":{"items":{"type":"string","uniqueKey":"ungrounded_fields.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Ungrounded Fields","uniqueKey":"ungrounded_fields","typeLabel":"string[]"},"generated_schema":{"oneOf":[{"type":"object","title":"Generated Schema","additionalProperties":true,"uniqueKey":"generated_schema.oneOf.0","typeLabel":"Generated Schema · object"},{"type":"null","title":"Generated Schema","uniqueKey":"generated_schema.oneOf.1","typeLabel":"null"}],"uniqueKey":"generated_schema","typeLabel":"Generated Schema · object | null"},"usage":{"oneOf":[{"type":"object","title":"BillingUsage","description":"What this request charged, in credits (plan 078 D6).\n\nPresent only on responses whose request was actually charged — absent\n(never null) on unbilled lanes (demo, legacy-PHI ledger) so pre-credits\nresponse shapes stay byte-identical. ``credits = pages × credits_per_page``\nat the v1 card: parse 1.0, schema extract 4.0 all-in.","required":["pages","credits","credits_per_page"],"properties":{"pages":{"type":"integer","title":"Pages","isRequired":true,"uniqueKey":"usage.oneOf.0.pages","typeLabel":"integer"},"credits":{"type":"number","title":"Credits","isRequired":true,"uniqueKey":"usage.oneOf.0.credits","typeLabel":"number"},"credits_per_page":{"type":"number","title":"Credits Per Page","isRequired":true,"uniqueKey":"usage.oneOf.0.credits_per_page","typeLabel":"number"}},"uniqueKey":"usage.oneOf.0","typeLabel":"BillingUsage · object"},{"type":"null","uniqueKey":"usage.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage","typeLabel":"BillingUsage · object | null"},"ocr_text":{"oneOf":[{"type":"string","title":"Ocr Text","uniqueKey":"ocr_text.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ocr Text","uniqueKey":"ocr_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"ocr_text","typeLabel":"string | null"}},"type":"object","required":["values","evidence","page_count"],"title":"SchemaExtractResponse","uniqueKey":"","typeLabel":"SchemaExtractResponse · object"},"examples":{"Example":{"title":"Example","value":{"values":{},"evidence":{},"page_count":123,"ungrounded_fields":["\u003cstring>"],"generated_schema":{},"usage":{"pages":123,"credits":123,"credits_per_page":123},"ocr_text":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"087cbde8-9906-46f6-b6a2-c0c98a6a469f":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"17eeecf0-4777-419a-8a17-579d26a34ec6":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"dd30c128-e109-412d-8b2e-00d772db84e5":{"url":"https://api.hanji.dev","description":"production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"X-API-KEY"}],"title":"APIKeyHeader"}]},"originalFileLocation":"openapi.json"},"subdomain":"youlearn-b6958d02","siteName":"Hanji","title":"Fill a schema from a document by URL - Hanji","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-11T22:42:38.910Z","originalFileLocation":"api-reference/v1/fill-a-schema-from-a-document-by-url.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Fill an arbitrary user JSON schema from a document URL, with citations.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hanji\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/youlearn-b6958d02/RkqqEpAEerHVf39r/_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/youlearn-b6958d02/RkqqEpAEerHVf39r/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/youlearn-b6958d02/RkqqEpAEerHVf39r/_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/youlearn-b6958d02/RkqqEpAEerHVf39r/_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/youlearn-b6958d02/RkqqEpAEerHVf39r/_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/youlearn-b6958d02/RkqqEpAEerHVf39r/_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/youlearn-b6958d02/RkqqEpAEerHVf39r/_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/youlearn-b6958d02/RkqqEpAEerHVf39r/_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/youlearn-b6958d02/RkqqEpAEerHVf39r/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Fill a schema from a document by URL - Hanji\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fill an arbitrary user JSON schema from a document URL, with citations.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hanji\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hanji.dev/api-reference/v1/fill-a-schema-from-a-document-by-url\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://youlearn-b6958d02.mintlify.site/_mintlify/api/og/v2?division=Schema+extraction\u0026amp;title=Fill+a+schema+from+a+document+by+URL\u0026amp;description=Fill+an+arbitrary+user+JSON+schema+from+a+document+URL%2C+with+citations.\u0026amp;theme=4faa1fd56b7cd8c28d323323\u0026amp;signature=360fb1fd1320b252231f480514e413695e741d4f415b8de6662599f42b3734f7\">\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=\"Fill a schema from a document by URL - Hanji\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fill an arbitrary user JSON schema from a document URL, with citations.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://youlearn-b6958d02.mintlify.site/_mintlify/api/og/v2?division=Schema+extraction\u0026amp;title=Fill+a+schema+from+a+document+by+URL\u0026amp;description=Fill+an+arbitrary+user+JSON+schema+from+a+document+URL%2C+with+citations.\u0026amp;theme=4faa1fd56b7cd8c28d323323\u0026amp;signature=360fb1fd1320b252231f480514e413695e741d4f415b8de6662599f42b3734f7\">\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/youlearn-b6958d02/RkqqEpAEerHVf39r/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hanji\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0c0c0c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hanji.dev/api-reference/v1/fill-a-schema-from-a-document-by-url\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v1/fill-a-schema-from-a-document-by-url.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hanji.dev/#organization\",\"name\":\"Hanji\",\"url\":\"https://docs.hanji.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/youlearn-b6958d02/Jy2a4ZjGgDJm0OsT/logo/light.svg?fit=max\u0026auto=format\u0026n=Jy2a4ZjGgDJm0OsT\u0026q=85\u0026s=04213e4d86750738bd50b582e537d2f0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hanji.dev#website\",\"name\":\"Hanji\",\"url\":\"https://docs.hanji.dev\",\"publisher\":{\"@id\":\"https://docs.hanji.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hanji.dev/api-reference/v1/fill-a-schema-from-a-document-by-url#webpage\",\"url\":\"https://docs.hanji.dev/api-reference/v1/fill-a-schema-from-a-document-by-url\",\"name\":\"Fill a schema from a document by URL\",\"description\":\"Fill an arbitrary user JSON schema from a document URL, with citations.\",\"dateModified\":\"2026-08-11T22:42:38.910Z\",\"isPartOf\":{\"@id\":\"https://docs.hanji.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hanji.dev/api-reference/v1/fill-a-schema-from-a-document-by-url#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hanji.dev/api-reference/v1/fill-a-schema-from-a-document-by-url#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Hanji\",\"item\":\"https://docs.hanji.dev\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Fill a schema from a document by URL\",\"item\":\"https://docs.hanji.dev/api-reference/v1/fill-a-schema-from-a-document-by-url\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hanji.dev/api-reference/v1/fill-a-schema-from-a-document-by-url#apireference\",\"headline\":\"Fill a schema from a document by URL\",\"name\":\"Fill a schema from a document by URL\",\"description\":\"Fill an arbitrary user JSON schema from a document URL, with citations.\",\"url\":\"https://docs.hanji.dev/api-reference/v1/fill-a-schema-from-a-document-by-url\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hanji.dev/api-reference/v1/fill-a-schema-from-a-document-by-url#webpage\"},\"dateModified\":\"2026-08-11T22:42:38.910Z\",\"publisher\":{\"@id\":\"https://docs.hanji.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hanji.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hanji\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hanji\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v1/fill-a-schema-from-a-document-by-url.md","siteName":"Hanji","nav":{"global":null,"pages":[{"title":"Introduction","sidebarTitle":"Introduction","href":"/introduction"},{"group":"Guides","pages":[{"title":"Batch processing","sidebarTitle":"Batch processing","href":"/guides/batch"},{"title":"Schema extraction","sidebarTitle":"Schema extraction","href":"/guides/schema-extraction"},{"title":"Webhooks","sidebarTitle":"Webhooks","href":"/guides/webhooks"}]},{"group":"Parse (sync)","pages":[{"title":"Parse a document by URL","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/parse","href":"/api-reference/v1/parse-a-document-by-url"},{"title":"Parse an uploaded document","description":"Accept a document as ``multipart/form-data`` and return chunks.\n\nMirrors ``POST /v1/parse`` in every way except how the document\narrives: same auth, same billing, same response schema, same error\nmapping. The filename is advisory; magic bytes drive kind detection.\n``POST /v1/extract/file`` is a compatibility alias.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/parse/file","href":"/api-reference/v1/parse-an-uploaded-document"}]},{"group":"Schema extraction","pages":[{"title":"Fill a schema from a document by URL","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/extract/schema","href":"/api-reference/v1/fill-a-schema-from-a-document-by-url"},{"title":"Fill a schema from an uploaded document","description":"Schema extraction from a ``multipart/form-data`` upload (PHI-capable).","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/extract/schema/file","href":"/api-reference/v1/fill-a-schema-from-an-uploaded-document"}]},{"group":"Async batch","pages":[{"title":"Register a file for batch upload","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/files","href":"/api-reference/v1/register-a-file-for-batch-upload"},{"title":"Check upload status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/files/{file_id}","href":"/api-reference/v1/check-upload-status"},{"title":"Create a batch","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/batches","href":"/api-reference/v1/create-a-batch"},{"title":"List your batches","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/batches","href":"/api-reference/v1/list-your-batches"},{"title":"Poll a batch","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/batches/{batch_id}","href":"/api-reference/v1/poll-a-batch"},{"title":"Download an item result","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/batches/{batch_id}/items/{item_id}/result","href":"/api-reference/v1/download-an-item-result"},{"title":"Cancel a batch","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/batches/{batch_id}/cancel","href":"/api-reference/v1/cancel-a-batch"},{"title":"batch.update webhook","openapi":"openapi.json webhook batch.update","href":"/api-reference/batch-update-webhook"}]}]},"basePath":"","title":"Fill a schema from a document by URL - Hanji","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}