{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Aryn Documentation","description":"Aryn is an agentic unstructured data warehouse that enables deep analyitcs and seach on documents at scale.","colors":{"primary":"#417586","light":"#417586","dark":"#417586"},"logo":{"light":"https://mintcdn.com/aryn/NmC_FCDeIgvkLjlo/logo/aryn_logo_full.png?fit=max\u0026auto=format\u0026n=NmC_FCDeIgvkLjlo\u0026q=85\u0026s=a98c5e045ec1cf0148d9df24e5e6b97a","dark":"https://mintcdn.com/aryn/NmC_FCDeIgvkLjlo/logo/aryn_logo_full.png?fit=max\u0026auto=format\u0026n=NmC_FCDeIgvkLjlo\u0026q=85\u0026s=a98c5e045ec1cf0148d9df24e5e6b97a"},"favicon":"aryn_logo.png","background":{"decoration":"windows"},"navbar":{"links":[{"href":"mailto:info@aryn.ai","label":"Get Support"},{"href":"https://aryn.instatus.com/","label":"Status Page"}],"primary":{"type":"button","label":"Website","href":"https://www.aryn.ai/"}},"footer":{"socials":{"x":"https://x.com/ArynInc","github":"https://github.com/aryn-ai","linkedin":"https://www.linkedin.com/company/aryn-ai"}},"seo":{"indexing":"all"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Aryn Blog","icon":"newspaper","href":"https://www.aryn.ai/blog"},{"anchor":"Slack Community","icon":"slack","href":"https://join.slack.com/t/aryn-community/shared_invite/zt-36vhennsx-mN3UsqD6PT2vxVZxpqdHsw"},{"anchor":"Sycamore - Document ETL","icon":"bars-staggered","href":"https://github.com/aryn-ai/sycamore"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"aryn","hasAudioNarration":false,"actualSubdomain":"aryn","customDomains":["docs.aryn.ai"],"gitSource":{"type":"github","owner":"aryn-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae9227764072a14c6718870:success","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"DocParse","count":41},{"language":"default","tag":"Aryn Platform","count":32},{"language":"default","tag":"API Reference","count":29},{"language":"default","tag":"Deep Analytics (Preview)","count":12},{"language":"default","tag":"Tutorials","count":10},{"language":"default","tag":"Document","count":10},{"language":"default","tag":"DocSet","count":7},{"language":"default","tag":"Partition","count":5},{"language":"default","tag":"Querying Data","count":4},{"language":"default","tag":"Query","count":4}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@aryn.ai"}},"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/transform/extract-properties","slug":"/api-reference/transform/extract-properties","pageMetadata":{"title":"Extract Properties","description":"Extract properties given in the schema from the DocSet.","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/jobs/extract-properties","href":"/api-reference/transform/extract-properties","autogeneratedByOpenApi":true,"hidden":false},"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: \"Extract properties given in the schema from the DocSet.\"\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":"Extract Properties","description":"Extract properties given in the schema from the DocSet.","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/jobs/extract-properties","href":"/api-reference/transform/extract-properties","autogeneratedByOpenApi":true,"hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Transform"],"summary":"Extract Properties","description":"Extract properties given in the schema from the DocSet.","operationId":"extract_properties_v1_jobs_extract_properties_post","security":["3c99de8a-cae5-4311-a6da-a6bbe73208f8"],"parameters":["b400a7e4-ef3f-43e5-87ee-60a1366363f6"],"requestBody":"bcdcd8e4-7ebc-4171-bd51-f5ef46ff5d79","responses":{"200":"0f3a2d78-24b7-400a-bf94-52c9d13b7e30","404":"20aa8810-05ac-4100-9ed6-5d108742bd60","422":"bda72299-9570-4f00-9645-1a20b11d8b9f"},"method":"post","type":"path","servers":["8f578b92-3513-451f-b34a-fce1ad6f83c3","8f62d6ca-6607-41db-84eb-8ccfc3ac24ec","bf169c67-b51a-48cb-b7ce-eb33167cd490","5f7a6f84-8d3c-4d22-b2cd-dab551ecd408"],"path":"/v1/jobs/extract-properties","baseUrlOptions":["https://api.aryn.cloud","https://api.aryn.ai","https://api.us.aryn.cloud","https://api.us.aryn.ai"],"title":"Extract Properties","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b400a7e4-ef3f-43e5-87ee-60a1366363f6":{"name":"docset_id","in":"query","required":true,"schema":{"type":"string","description":"The ID of the DocSet to extract properties from","title":"Docset Id","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"The ID of the DocSet to extract properties from"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"properties":{"items":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the property.","isRequired":true,"uniqueKey":"properties.items.[INDEX].name","typeLabel":"string"},"field_type":{"type":"string","title":"Field Type","description":"The type of the field.","isRequired":true,"uniqueKey":"properties.items.[INDEX].field_type","typeLabel":"string"},"default":{"oneOf":[{"title":"Default","description":"The default value for the property.","uniqueKey":"properties.items.[INDEX].default.oneOf.0","typeLabel":"any"},{"type":"null","title":"Default","description":"The default value for the property.","uniqueKey":"properties.items.[INDEX].default.oneOf.1","typeLabel":"null"}],"uniqueKey":"properties.items.[INDEX].default","typeLabel":"any | null"},"description":{"oneOf":[{"type":"string","title":"Description","description":"A natural language description of the property.","uniqueKey":"properties.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"A natural language description of the property.","uniqueKey":"properties.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"properties.items.[INDEX].description","typeLabel":"string | null"},"examples":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"properties.items.[INDEX].examples.oneOf.0.items.[INDEX]","typeLabel":"any"},"title":"Examples","description":"A list of example values for the property.","uniqueKey":"properties.items.[INDEX].examples.oneOf.0","typeLabel":"any[]"},{"type":"null","title":"Examples","description":"A list of example values for the property.","uniqueKey":"properties.items.[INDEX].examples.oneOf.1","typeLabel":"null"}],"uniqueKey":"properties.items.[INDEX].examples","typeLabel":"any[] | null"}},"type":"object","required":["name","field_type"],"title":"SchemaProperty","description":"Represents a field in a DocSet schema.","uniqueKey":"properties.items.[INDEX]","typeLabel":"SchemaProperty · object"},"type":"array","title":"Properties","description":"A list of properties belong to this schema.","isRequired":true,"uniqueKey":"properties","typeLabel":"SchemaProperty · object[]"}},"type":"object","required":["properties"],"title":"Schema","description":"A Schema describing the fields to extract from the DocSet","uniqueKey":"","typeLabel":"Schema · object"},"examples":{"Example":{"title":"Example","value":{"properties":[{"name":"\u003cstring>","field_type":"\u003cstring>","default":"\u003cunknown>","description":"\u003cstring>","examples":["\u003cunknown>"]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"0f3a2d78-24b7-400a-bf94-52c9d13b7e30":{"description":"Successful Response","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"20aa8810-05ac-4100-9ed6-5d108742bd60":{"description":"Not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"bda72299-9570-4f00-9645-1a20b11d8b9f":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3c99de8a-cae5-4311-a6da-a6bbe73208f8":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"8f578b92-3513-451f-b34a-fce1ad6f83c3":{"url":"https://api.aryn.cloud","description":"US Region"},"8f62d6ca-6607-41db-84eb-8ccfc3ac24ec":{"url":"https://api.aryn.ai","description":"US Region"},"bf169c67-b51a-48cb-b7ce-eb33167cd490":{"url":"https://api.us.aryn.cloud","description":"US Region"},"5f7a6f84-8d3c-4d22-b2cd-dab551ecd408":{"url":"https://api.us.aryn.ai","description":"US Region"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api-reference/endpoint/platform/openapi.json"},"subdomain":"aryn","siteName":"Aryn Documentation","title":"Extract Properties - Aryn Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-12-10T22:09:50.295Z","originalFileLocation":"api-reference/transform/extract-properties.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=\"Extract properties given in the schema from the DocSet.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Aryn 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/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_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/aryn/w2LZ1a3vrOj9YzXF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Extract Properties - Aryn Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Extract properties given in the schema from the DocSet.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aryn Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.aryn.ai/api-reference/transform/extract-properties\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://aryn.mintlify.site/_mintlify/api/og/v2?division=Transform\u0026amp;title=Extract+Properties\u0026amp;description=Extract+properties+given+in+the+schema+from+the+DocSet.\u0026amp;theme=be158e76b417b7e99b2d8f02\u0026amp;signature=7dafb63323a805273eade40a9fc2508cf38c3d3823a8cb274db41d054fc3f023\">\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=\"Extract Properties - Aryn Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Extract properties given in the schema from the DocSet.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://aryn.mintlify.site/_mintlify/api/og/v2?division=Transform\u0026amp;title=Extract+Properties\u0026amp;description=Extract+properties+given+in+the+schema+from+the+DocSet.\u0026amp;theme=be158e76b417b7e99b2d8f02\u0026amp;signature=7dafb63323a805273eade40a9fc2508cf38c3d3823a8cb274db41d054fc3f023\">\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/aryn/w2LZ1a3vrOj9YzXF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aryn Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#417586\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.aryn.ai/api-reference/transform/extract-properties\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/transform/extract-properties.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.aryn.ai/#organization\",\"name\":\"Aryn Documentation\",\"url\":\"https://docs.aryn.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/aryn/NmC_FCDeIgvkLjlo/logo/aryn_logo_full.png?fit=max\u0026auto=format\u0026n=NmC_FCDeIgvkLjlo\u0026q=85\u0026s=a98c5e045ec1cf0148d9df24e5e6b97a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.aryn.ai#website\",\"name\":\"Aryn Documentation\",\"url\":\"https://docs.aryn.ai\",\"publisher\":{\"@id\":\"https://docs.aryn.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.aryn.ai/api-reference/transform/extract-properties#webpage\",\"url\":\"https://docs.aryn.ai/api-reference/transform/extract-properties\",\"name\":\"Extract Properties\",\"description\":\"Extract properties given in the schema from the DocSet.\",\"dateModified\":\"2025-12-10T22:09:50.295Z\",\"isPartOf\":{\"@id\":\"https://docs.aryn.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.aryn.ai/api-reference/transform/extract-properties#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.aryn.ai/api-reference/transform/extract-properties#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Aryn Platform\",\"item\":\"https://docs.aryn.ai/api-reference/document/list-docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Extract Properties\",\"item\":\"https://docs.aryn.ai/api-reference/transform/extract-properties\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.aryn.ai/api-reference/transform/extract-properties#apireference\",\"headline\":\"Extract Properties\",\"name\":\"Extract Properties\",\"description\":\"Extract properties given in the schema from the DocSet.\",\"url\":\"https://docs.aryn.ai/api-reference/transform/extract-properties\",\"mainEntityOfPage\":{\"@id\":\"https://docs.aryn.ai/api-reference/transform/extract-properties#webpage\"},\"dateModified\":\"2025-12-10T22:09:50.295Z\",\"publisher\":{\"@id\":\"https://docs.aryn.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.aryn.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aryn Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Aryn Documentation","nav":{"global":{"anchors":[{"anchor":"Aryn Blog","icon":"newspaper","href":"https://www.aryn.ai/blog"},{"anchor":"Slack Community","icon":"slack","href":"https://join.slack.com/t/aryn-community/shared_invite/zt-36vhennsx-mN3UsqD6PT2vxVZxpqdHsw"},{"anchor":"Sycamore - Document ETL","icon":"bars-staggered","href":"https://github.com/aryn-ai/sycamore"}]},"tabs":[{"tab":"DocParse","pages":[{"title":"DocParse","href":"/docparse/introduction"}]},{"tab":"Deep Analytics (Preview)","pages":[{"title":"Deep Analytics (Preview)","href":"/introduction"}]},{"tab":"SDK Reference","pages":[{"title":"SDK Reference","href":"/sdk-reference/partition"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"DocParse","pages":[{"group":"Partition","pages":[{"title":"Partition Document","deprecated":null,"version":null,"openapi":"api-reference/endpoint/docparse/openapi.json post /v1/document/partition","href":"/api-reference/partition/partition-document"},{"title":"Submit Document for Async Partitioning","deprecated":null,"version":null,"openapi":"api-reference/endpoint/docparse/openapi.json post /v1/async/submit/document/partition","href":"/api-reference/partition/submit-document-for-async-partitioning"},{"title":"Get Async Task Status","deprecated":null,"version":null,"openapi":"api-reference/endpoint/docparse/openapi.json get /v1/async/result/{task_id}","href":"/api-reference/partition/get-async-task-status"},{"title":"Cancel Async Task","deprecated":null,"version":null,"openapi":"api-reference/endpoint/docparse/openapi.json post /v1/async/cancel/{task_id}","href":"/api-reference/partition/cancel-async-task"},{"title":"List Async Tasks","deprecated":null,"version":null,"openapi":"api-reference/endpoint/docparse/openapi.json get /v1/async/list","href":"/api-reference/partition/list-async-tasks"}]}]},{"group":"Aryn Platform","pages":[{"group":"Document","pages":[{"title":"List Docs","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/storage/docsets/{docset_id}/docs","href":"/api-reference/document/list-docs"},{"title":"Add Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/storage/docsets/{docset_id}/docs","href":"/api-reference/document/add-doc"},{"title":"Submit Document for Async Add Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/async/submit/storage/docsets/{docset_id}/docs","href":"/api-reference/document/submit-document-for-async-add-doc"},{"title":"Get Async Task Status","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/async/result/{task_id}","href":"/api-reference/document/get-async-task-status"},{"title":"Cancel Async Task for Add Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/async/cancel/{task_id}","href":"/api-reference/document/cancel-async-task-for-add-doc"},{"title":"List Async Tasks for Add Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/async/list","href":"/api-reference/document/list-async-tasks-for-add-doc"},{"title":"Get Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/storage/docsets/{docset_id}/docs/{doc_id}","href":"/api-reference/document/get-doc"},{"title":"Delete Doc","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json delete /v1/storage/docsets/{docset_id}/docs/{doc_id}","href":"/api-reference/document/delete-doc"},{"title":"Update Doc Properties","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json patch /v1/storage/docsets/{docset_id}/docs/{doc_id}/properties","href":"/api-reference/document/update-doc-properties"},{"title":"Get Doc Binary","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/storage/docsets/{docset_id}/docs/{doc_id}/binary","href":"/api-reference/document/get-doc-binary"}]},{"group":"DocSet","pages":[{"title":"List Docsets","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/storage/docsets","href":"/api-reference/docset/list-docsets"},{"title":"Create Docset","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/storage/docsets","href":"/api-reference/docset/create-docset"},{"title":"Get Docset","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json get /v1/storage/docsets/{docset_id}","href":"/api-reference/docset/get-docset"},{"title":"Delete Docset","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json delete /v1/storage/docsets/{docset_id}","href":"/api-reference/docset/delete-docset"},{"title":"Update Docset","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json patch /v1/storage/docsets/{docset_id}","href":"/api-reference/docset/update-docset"},{"title":"Clone Docset","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/storage/docsets/{docset_id}/clone","href":"/api-reference/docset/clone-docset"},{"title":"Set Readonly Docset","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/storage/docsets/{docset_id}/readonly/{value}","href":"/api-reference/docset/set-readonly-docset"}]},{"group":"Query","pages":[{"title":"Generate Plan","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/query/plan","href":"/api-reference/query/generate-plan"},{"title":"Edit Plan","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json patch /v1/query/plan","href":"/api-reference/query/edit-plan"},{"title":"Run Query","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/query","href":"/api-reference/query/run-query"},{"title":"Search","description":"Run a search query.","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/query/search/{docset_id}","href":"/api-reference/query/search"}]},{"group":"Transform","pages":[{"title":"Extract Properties","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/jobs/extract-properties","href":"/api-reference/transform/extract-properties"},{"title":"Delete Properties","description":"Delete properties given in the schema from the DocSet.","deprecated":null,"version":null,"openapi":"api-reference/endpoint/platform/openapi.json post /v1/jobs/delete-properties","href":"/api-reference/transform/delete-properties"}]}]}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/example-code/introduction"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release_notes"}]},{"tab":"Model Context Protocol (MCP) Server","pages":[{"title":"Model Context Protocol (MCP) Server","href":"/mcp-server/aryn_mcp"}]}]},"basePath":"","title":"Extract Properties - Aryn Documentation","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}