Apply schema extraction to a previously saved extraction. The mode is
inferred from the input:
Single mode — Provide extraction_id + schema_config (or
schema_config_id) to apply one schema to the entire document.
Multi-extraction mode — Provide a batch extract ID as extraction_id
(auto-detected) or an explicit extraction_ids list. The content from all
extractions is combined and the schema is applied to the composite. Citations
use extraction_id-bb_id format to disambiguate across source documents.
Split mode — Provide split_id + split_schema_config to apply
different schemas to different page groups from a prior /split call.
Each topic can have its own schema, prompt, and effort setting.
An explicit root properties must contain at least one field; an empty object
is refused with HTTP 400 before processing.
Creates a versioned schema record that can be retrieved later.
Set async: true to return immediately with a job_id for polling.
Schema retention covers the job result and its saved schema files. When first-fetch deletion
is enabled, a synchronous response or completed job poll that returns the full result inline
consumes it. A response containing a result URL preserves the output until its first download
through GET /results/{jobId}. This policy uses API download URLs even when the org normally
uses presigned storage URLs. Failed-job data is cleaned after the first failed poll when this
policy is enabled. The source extraction and other schema versions keep their own retention.
Pipeline Step 2 or 3 — Schema requires a prior extraction. For split mode, it also requires a prior split. The mode is inferred from the input fields you provide.
Apply a schema to previously extracted documents to get structured data output. This endpoint supports multiple modes, inferred from the input:
Single mode — provide extraction_id to apply one schema to a single document
Multi-extraction mode — provide a batch extract ID as extraction_id (auto-detected) or an explicit extraction_ids list to combine content from multiple documents and apply the schema to the composite
Split mode — provide split_id to apply per-topic schemas to page groups from a prior /split
This endpoint operates on saved extractions (created via /extract with storage enabled, which is the default).
To apply schemas across many extractions or splits at once, use Batch Schema. It supports both single and split modes.
Async Mode
Set async: true to return immediately with a job ID for polling. See Polling for Results for details.
Field
Type
Required
Description
async
boolean
No
If true, returns immediately with a job_id for polling. Default: false.
JSON Schema defining the structured data to extract
schema_prompt
string
No
Natural language instructions to guide extraction
effort
boolean
No
Enable extended reasoning for complex documents
agentic_confidence
boolean
No
Return a per-field confidence score (0-1) in confidence, backed by additional verification of the extracted values. Billed 3 additional credits per page; must be enabled for your organization
Response (200)
Field
Type
Description
schema_id
uuid
Unique identifier for this schema version
version
integer
Schema version number
schema_output
object
{ values: {...}, citations: {...}, confidence: {...} } — values holds the extracted data, citations the source element IDs per field, and confidence a 0-1 score per field (mirrors the shape of values). With agentic_confidence: true, every value is additionally verified and the scores reflect that verification.
extraction_ids
uuid[]
Present when multiple extractions were combined — lists all source extraction IDs
Combine content from multiple documents and apply a single schema to the composite, producing one merged result. This is useful when the data you need spans across several files (e.g., a loss summary in one file and exposure data in another).
This is different from Batch Schema, which applies the same schema to each document independently (one result per document). Use multi-extraction when you need to cross-reference or merge data from multiple source files into a single output.
There are two ways to trigger multi-extraction:
Batch extract auto-detection — Pass a batch extract batch_job_id as extraction_id. The system detects it as a batch parent and automatically combines all completed child extractions.
Explicit list — Pass an extraction_ids array with the specific extraction IDs to combine.
Citations in multi-extraction results use the extraction_id-bb_id format (e.g., abc123-txt-1) to disambiguate bounding boxes across source documents.
from pulse import Pulsefrom pulse.types.schema_config import SchemaConfigclient = Pulse(api_key="YOUR_API_KEY")# Option 1: Pass a batch extract job ID (auto-detected)schema_result = client.schema( extraction_id="<batch_job_id>", schema_config=SchemaConfig( input_schema={ "type": "object", "properties": { "policy_period": {"type": "string"}, "exposure": {"type": "number"}, }, }, schema_prompt="Combine data from both documents", ),)# Option 2: Pass an explicit list of extraction IDsschema_result = client.schema( extraction_ids=["extraction-1-uuid", "extraction-2-uuid"], schema_config=SchemaConfig( input_schema={ "type": "object", "properties": { "policy_period": {"type": "string"}, "exposure": {"type": "number"}, }, }, ),)# Response includes the list of source extraction IDsprint(schema_result.extraction_ids)
Must provide extraction_id, extraction_ids, or split_id
400
Invalid schema
Schema must follow JSON Schema / OpenAPI 3.0 format
400
agentic_confidence not enabled
agentic_confidence: true requires the feature to be enabled for your organization
401
Unauthorized
Invalid or missing API key
404
Not found
Extraction, batch job, or split not found
500
Processing error
Schema extraction failed
Best Practices
Use effort mode for complex documents
Set effort: true for documents with complex layouts, tables, or when initial extraction quality is low.
Use agentic confidence when you need a trust signal per field
Set agentic_confidence: true to have every extracted field verified and scored: each field in confidence carries a 0-1 score you can route to review. It adds 3 credits per page and some latency, and must be enabled for your organization.
Provide schema_prompt for context
Add natural language instructions to guide the extraction, especially for ambiguous fields.
Use async for large schemas
If your schema has many fields or the document is large, set async: true to avoid timeouts. See Polling for Results.
For multi-section documents, use split mode
First call /split to get page groups, then use this endpoint with split_id + split_schema_config.
Combine data from multiple files with multi-extraction
When the data you need spans multiple documents, use Batch Extract to extract all files, then pass the batch_job_id as extraction_id to this endpoint. The system auto-detects the batch parent and combines content from all child extractions.
Related Endpoints
Extract
Extract content from a document
Split Document
Split a document into topic-based page groups
Batch Processing
Apply schema across many documents in parallel
Authorizations
x-api-key
string
header
required
Headers
Pulse-Version
enum<string>
default:1
The API version. These pages document version 1.
Available options:
1
Body
application/json
Request body for schema extraction. Mode is inferred from the input:
Provide extraction_id for single-mode or multi-extraction (auto-detected).
If the ID belongs to a batch extract, its child extractions are combined automatically.
Provide extraction_ids for an explicit list of extractions to combine.
Provide split_id + split_schema_config for split-mode extraction.
extraction_id
string<uuid>
ID of a saved extraction OR a batch extract job. When a batch extract ID is provided, the system auto-detects it and combines all completed child extractions into a single schema application.
extraction_ids
string<uuid>[]
Explicit list of extraction IDs to combine. The markdown and bounding boxes from all extractions are merged and the schema is applied to the composite content. Citations use extraction_id-bb_id format to disambiguate across source documents.
split_id
string<uuid>
ID of saved split (from a prior /split call). Use for split-mode schema extraction.
schema_config
object
Inline schema configuration for single mode. Required (with extraction_id) if schema_config_id is not provided.
Show child attributes
schema_config_id
string<uuid>
Reference to a saved schema configuration for single mode. Use this instead of providing schema_config inline.
split_schema_config
object
Per-topic schema configurations for split mode. Keys must match the topic names from the split. Each topic provides either inline schema or schema_config_id.
Show child attributes
async
boolean
default:false
If true, returns immediately with a job_id for polling via GET /job/{jobId}. Otherwise processes synchronously.
Response
Schema extraction result (when async=false or omitted). Shape depends on the mode used.
Option 1
Option 2
Option 3
Response for single schema extraction mode.
schema_id
string<uuid>
required
Unique identifier for this schema version.
version
integer
required
Version number of this schema for the extraction.
Required range: x >= 1
schema_output
object
required
Extracted values and citations.
Show child attributes
extraction_ids
string<uuid>[]
Present when multiple extractions were combined (via batch extract auto-detection or explicit extraction_ids input). Lists all source extraction IDs that contributed to the result.
credits_used
number<float> | null
Number of credits consumed by this request. Only present when the organization has the credit billing system enabled.
plan_info
object
Billing tier and cumulative usage information for the calling org, including this schema run.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pulse API","colors":{"primary":"#3573f6","light":"#4a90f9","dark":"#2561ef"},"logo":{"light":"https://mintcdn.com/pulseai/OJ897TEZf8bV6lk8/logo-icon.svg?fit=max\u0026auto=format\u0026n=OJ897TEZf8bV6lk8\u0026q=85\u0026s=1062873c6d0f5dd9971e379f2210c1cb","dark":"https://mintcdn.com/pulseai/OJ897TEZf8bV6lk8/logo-icon.svg?fit=max\u0026auto=format\u0026n=OJ897TEZf8bV6lk8\u0026q=85\u0026s=1062873c6d0f5dd9971e379f2210c1cb"},"favicon":"https://mintcdn.com/pulseai/OJ897TEZf8bV6lk8/logo-icon.svg?fit=max\u0026auto=format\u0026n=OJ897TEZf8bV6lk8\u0026q=85\u0026s=1062873c6d0f5dd9971e379f2210c1cb","api":{"openapi":{"source":"api-reference/openapi.yml","overlays":["api-reference/pulse-version.overlay.yaml"]}},"appearance":{"default":"light","strict":true},"background":{"color":{"light":"#ffffff","dark":"#000000"}},"navbar":{"links":[{"href":"https://platform.runpulse.com","label":"Platform"},{"href":"mailto:support@trypulse.ai","label":"Support"}],"primary":{"type":"button","label":"Get API Key","href":"https://platform.runpulse.com/"}},"footer":{"socials":{"x":"https://x.com/Pulse__AI","linkedin":"https://www.linkedin.com/company/pulse-ai-corp"}},"fonts":{"heading":{"family":"Inria Serif"},"body":{"family":"Geist"}},"icons":{"library":"fontawesome"},"integrations":{"posthog":{"apiKey":"phc_FutnpUqAQasGvZ2zQSA1mt9uu14YLiO85JV69tm0cYz"}},"banner":{"content":"**Pulse API v2 is here.** Upgrading from v1? Read [Moving from V1](/v2/moving-from-v1).","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pulseai","hasAudioNarration":false,"actualSubdomain":"pulseai","customDomains":["docs.runpulse.com"],"gitSource":{"type":"github","owner":"pulse-software-corp","repo":"pulse-api","deployBranch":"pulse-dev","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":"","_id":"6aea3a8ca753b7b0d57a1a6e"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af7adea73417820f2ea77c4","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API Reference","count":201},{"language":"default","tag":"Documentation","count":84},{"language":"default","tag":"Errors","count":46},{"language":"default","tag":"Codes","count":45},{"language":"default","tag":"Configs","count":42},{"language":"default","tag":"Cookbooks","count":40},{"language":"default","tag":"Platform Reference","count":28},{"language":"default","tag":"Core Concepts","count":19},{"language":"default","tag":"Agent Tools","count":16},{"language":"default","tag":"Pipeline Steps","count":14}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":".build-examples{position:relative;padding-left:48px}.build-examples::before{content:'';position:absolute;left:23px;top:48px;bottom:48px;width:2px;background-color:rgba(255, 255, 255, 0.1)}.example{display:flex;align-items:flex-start;margin-bottom:48px;position:relative}.icon-container{position:relative;left:-48px;margin-right:-24px;width:46px;height:46px;border-radius:12px;background:#1c1c1c;border:1px solid rgba(255, 255, 255, 0.1);display:flex;align-items:center;justify-content:center;z-index:1}.icon-container i{font-size:20px;color:#ffffff}.content{flex:1}.content h3{margin:0 0 8px 0;font-size:20px;font-weight:500}.content p{margin:0;color:rgba(255, 255, 255, 0.7);line-height:1.5}.nav-logo-name{display:flex!important;color:#ffffff;font-size:1.2rem;font-weight:500}.logo-title{display:block!important;visibility:visible!important;opacity:1!important}img[src*=\"/images/platform/\"]{display:block;width:auto;max-width:100%;height:auto;margin:16px auto 24px;background:#ffffff;border:1px solid rgba(15, 23, 42, 0.14);border-radius:8px;box-shadow:0 1px 1px rgba(15, 23, 42, 0.04)}html[class~=\"dark\"] img[src*=\"/images/platform/\"]{background:#020617;border-color:rgba(226, 232, 240, 0.16);box-shadow:0 1px 1px rgba(0, 0, 0, 0.28)}figure.frame img{max-height:440px;width:auto}.mdx-content[data-page-href*=\"/v2/\"] .mermaid svg{max-height:460px}#content-area:has(.api-section) #page-title{font-size:28px;line-height:1.25}#content-area:has(.api-section) .mt-2.text-lg.prose,#content-area:has(.api-section) .mt-2.text-lg.prose p{font-size:14px;line-height:1.6}.api-section-heading-title{margin-top:1rem}.api-section-heading{row-gap:0.5rem}.api-section .pt-6.pb-4{padding-top:0.25rem;padding-bottom:0.25rem}.primitive-param-field>.py-6,.object-param-field>.py-6{padding-top:0.75rem;padding-bottom:0.75rem}.primitive-param-field>.py-6>.mt-4,.object-param-field>.py-6>.mt-4{margin-top:0.25rem}[data-component-part=\"field-info-pill\"]{word-break:normal;overflow-wrap:anywhere}[data-pulse-more]>div>.param-head{cursor:pointer}[data-pulse-more]>div>.param-head::before{content:'';position:absolute;left:-16px;top:8px;width:6px;height:6px;border-right:1.5px solid currentColor;border-bottom:1.5px solid currentColor;color:rgb(120 113 108);transform:rotate(-45deg);transition:transform 0.15s}[data-pulse-open]>div>.param-head::before{transform:rotate(45deg);top:6px}[data-pulse-extra]:not([data-pulse-shown]){display:none}[data-pulse-extra]{margin-top:0.5rem}details[data-pulse-children]{margin-top:0.25rem;border:0}details[data-pulse-children]>summary{display:none}details[data-pulse-children]>.expandable-content{margin:0;padding:0 0 0 1rem;border-top:0;border-left:1px solid rgb(231 229 228)}html.dark details[data-pulse-children]>.expandable-content{border-left-color:rgb(255 255 255 / 0.1)}.method-nav-pill{width:auto}.method-nav-pill>[data-pulse-method]{display:inline-flex;align-items:center;justify-content:center;width:20px;height:20px;padding:0;border-radius:5px;font-size:0;color:var(--pulse-method-color);background:var(--pulse-method-tint)}.method-nav-pill>[data-pulse-method]::before{content:'';width:13px;height:13px;background-color:currentColor;-webkit-mask:var(--pulse-method-icon) center / contain no-repeat;mask:var(--pulse-method-icon) center / contain no-repeat}[data-pulse-method=\"post\"]{--pulse-method-color: #1d4ed8;--pulse-method-tint: #dbeafe;--pulse-method-icon: url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M7 7h10v10'/%3E%3Cpath d='M7 17 17 7'/%3E%3C/svg%3E\")}[data-pulse-method=\"get\"]{--pulse-method-color: #15803d;--pulse-method-tint: #dcfce7;--pulse-method-icon: url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M17 7 7 17'/%3E%3Cpath d='M17 17H7V7'/%3E%3C/svg%3E\")}[data-pulse-method=\"del\"],[data-pulse-method=\"delete\"]{--pulse-method-color: #b91c1c;--pulse-method-tint: #fee2e2;--pulse-method-icon: url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M18 6 6 18'/%3E%3Cpath d='m6 6 12 12'/%3E%3C/svg%3E\")}[data-pulse-method=\"patch\"],[data-pulse-method=\"put\"]{--pulse-method-color: #b45309;--pulse-method-tint: #fef3c7;--pulse-method-icon: url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='black' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M21.174 6.812a1 1 0 0 0-3.986-3.987L3.842 16.174a2 2 0 0 0-.5.83l-1.321 4.352a.5.5 0 0 0 .623.622l4.353-1.32a2 2 0 0 0 .83-.497z'/%3E%3Cpath d='m15 5 4 4'/%3E%3C/svg%3E\")}html.dark [data-pulse-method=\"post\"]{--pulse-method-color: #93c5fd;--pulse-method-tint: rgb(59 130 246 / 0.2)}html.dark [data-pulse-method=\"get\"]{--pulse-method-color: #86efac;--pulse-method-tint: rgb(34 197 94 / 0.2)}html.dark [data-pulse-method=\"del\"],html.dark [data-pulse-method=\"delete\"]{--pulse-method-color: #fca5a5;--pulse-method-tint: rgb(239 68 68 / 0.2)}html.dark [data-pulse-method=\"patch\"],html.dark [data-pulse-method=\"put\"]{--pulse-method-color: #fcd34d;--pulse-method-tint: rgb(245 158 11 / 0.2)}[data-testid=\"try-it-button\"]{display:none}#content-area div:has(>div>div>.method-pill),#content-area div:has(>.method-pill){border:0;padding:0;background:none}#content-area div:has(>.method-pill){gap:0.5rem}.method-pill[data-pulse-method]{display:inline-flex;align-items:center;gap:4px;padding:1px 6px;border-radius:5px;font-size:12px;font-weight:500;line-height:18px;color:var(--pulse-method-color);background:var(--pulse-method-tint)}.method-pill[data-pulse-method]::before{content:'';width:12px;height:12px;background-color:currentColor;-webkit-mask:var(--pulse-method-icon) center / contain no-repeat;mask:var(--pulse-method-icon) center / contain no-repeat}#content-area div:has(>.method-pill) [data-component-part=\"scroll-area-content\"] div{font-size:13px;font-weight:400;color:rgb(82 81 78)}html.dark #content-area div:has(>.method-pill) [data-component-part=\"scroll-area-content\"] div{color:rgb(255 255 255 / 0.6)}"}],"page":{"pagePath":"api-reference/endpoint/schema","slug":"/api-reference/endpoint/schema","pageMetadata":{"title":"Schema Extraction","openapi":"api-reference/openapi.yml POST /schema","description":"Apply schema extraction to a previously saved extraction. The mode is\ninferred from the input:\n\n**Single mode** — Provide `extraction_id` + `schema_config` (or\n`schema_config_id`) to apply one schema to the entire document.\n\n**Multi-extraction mode** — Provide a batch extract ID as `extraction_id`\n(auto-detected) or an explicit `extraction_ids` list. The content from all\nextractions is combined and the schema is applied to the composite. Citations\nuse `extraction_id-bb_id` format to disambiguate across source documents.\n\n**Split mode** — Provide `split_id` + `split_schema_config` to apply\ndifferent schemas to different page groups from a prior `/split` call.\nEach topic can have its own schema, prompt, and effort setting.\n\nAn explicit root `properties` must contain at least one field; an empty object\nis refused with HTTP 400 before processing.\n\nCreates a versioned schema record that can be retrieved later.\nSet `async: true` to return immediately with a job_id for polling.\n\nSchema retention covers the job result and its saved schema files. When first-fetch deletion\nis enabled, a synchronous response or completed job poll that returns the full result inline\nconsumes it. A response containing a result URL preserves the output until its first download\nthrough `GET /results/{jobId}`. This policy uses API download URLs even when the org normally\nuses presigned storage URLs. Failed-job data is cleaned after the first failed poll when this\npolicy is enabled. The source extraction and other schema versions keep their own retention.\n\nTo apply schemas across many extractions or splits at once, see\n[Batch Schema](api:POST/batch/schema) or the\n[Batch Processing guide](/batch).","href":"/api-reference/endpoint/schema"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Apply schema extraction to a previously saved extraction. The mode is\\ninferred from the input:\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Single mode\"\n }), \" — Provide \", _jsx(_components.code, {\n children: \"extraction_id\"\n }), \" + \", _jsx(_components.code, {\n children: \"schema_config\"\n }), \" (or\\n\", _jsx(_components.code, {\n children: \"schema_config_id\"\n }), \") to apply one schema to the entire document.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Multi-extraction mode\"\n }), \" — Provide a batch extract ID as \", _jsx(_components.code, {\n children: \"extraction_id\"\n }), \"\\n(auto-detected) or an explicit \", _jsx(_components.code, {\n children: \"extraction_ids\"\n }), \" list. The content from all\\nextractions is combined and the schema is applied to the composite. Citations\\nuse \", _jsx(_components.code, {\n children: \"extraction_id-bb_id\"\n }), \" format to disambiguate across source documents.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Split mode\"\n }), \" — Provide \", _jsx(_components.code, {\n children: \"split_id\"\n }), \" + \", _jsx(_components.code, {\n children: \"split_schema_config\"\n }), \" to apply\\ndifferent schemas to different page groups from a prior \", _jsx(_components.code, {\n children: \"/split\"\n }), \" call.\\nEach topic can have its own schema, prompt, and effort setting.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"An explicit root \", _jsx(_components.code, {\n children: \"properties\"\n }), \" must contain at least one field; an empty object\\nis refused with HTTP 400 before processing.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Creates a versioned schema record that can be retrieved later.\\nSet \", _jsx(_components.code, {\n children: \"async: true\"\n }), \" to return immediately with a job_id for polling.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Schema retention covers the job result and its saved schema files. When first-fetch deletion\\nis enabled, a synchronous response or completed job poll that returns the full result inline\\nconsumes it. A response containing a result URL preserves the output until its first download\\nthrough \", _jsx(_components.code, {\n children: \"GET /results/{jobId}\"\n }), \". This policy uses API download URLs even when the org normally\\nuses presigned storage URLs. Failed-job data is cleaned after the first failed poll when this\\npolicy is enabled. The source extraction and other schema versions keep their own retention.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"To apply schemas across many extractions or splits at once, see\\n\", _jsx(_components.a, {\n href: \"api:POST/batch/schema\",\n children: \"Batch Schema\"\n }), \" or the\\n\", _jsx(_components.a, {\n href: \"/batch\",\n children: \"Batch Processing guide\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,Card,CardGroup,CodeBlock,CodeGroup,Heading,Info,Note,Tab,Table,Tabs}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Pipeline Step 2 or 3`}),` — Schema requires a prior `,_jsx(_components.a,{href:`/api-reference/endpoint/extract`,children:`extraction`}),`. For split mode, it also requires a prior `,_jsx(_components.a,{href:`/api-reference/endpoint/split`,children:`split`}),`. The mode is inferred from the input fields you provide.`]})}),`\n`,_jsx(_components.p,{children:`Apply a schema to previously extracted documents to get structured data output. This endpoint supports multiple modes, inferred from the input:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Single mode`}),` — provide `,_jsx(_components.code,{children:`extraction_id`}),` to apply one schema to a single document`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Multi-extraction mode`}),` — provide a batch extract ID as `,_jsx(_components.code,{children:`extraction_id`}),` (auto-detected) or an explicit `,_jsx(_components.code,{children:`extraction_ids`}),` list to combine content from multiple documents and apply the schema to the composite`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Split mode`}),` — provide `,_jsx(_components.code,{children:`split_id`}),` to apply per-topic schemas to page groups from a prior `,_jsx(_components.code,{children:`/split`})]}),`\n`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`This endpoint operates on `,_jsx(_components.strong,{children:`saved extractions`}),` (created via `,_jsx(_components.code,{children:`/extract`}),` with storage enabled, which is the default).`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`To apply schemas across many extractions or splits at once, use `,_jsx(_components.a,{href:`/api-reference/endpoint/batch-overview#batch-schema`,children:`Batch Schema`}),`. It supports both single and split modes.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`async-mode`,children:`Async Mode`}),`\n`,_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`async: true`}),` to return immediately with a job ID for polling. See `,_jsx(_components.a,{href:`/api-reference/endpoint/poll`,children:`Polling for Results`}),` for details.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`async`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`If `,_jsx(_components.code,{children:`true`}),`, returns immediately with a `,_jsx(_components.code,{children:`job_id`}),` for `,_jsx(_components.a,{href:`/api-reference/endpoint/poll`,children:`polling`}),`. Default: `,_jsx(_components.code,{children:`false`}),`.`]})]})})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Async Response (200)`}),`:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`job_id`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Job ID for `,_jsx(_components.a,{href:`/api-reference/endpoint/poll`,children:`polling`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`\"pending\"`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`message`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Human-readable description`})]})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`mode-reference`,children:`Mode Reference`}),`\n`,_jsxs(Tabs,{children:[_jsxs(Tab,{title:`Single Mode`,id:`single-mode`,\"data-child-heading-ids\":`[\"request\",\"schema-config\",\"response-200\",\"example-%E2%80%94-inline-schema\",\"example-%E2%80%94-saved-config-reference\",\"example-response\",\"multi-extraction\"]`,children:[_jsx(Heading,{level:`3`,id:`request`,children:`Request`}),_jsx(_components.p,{children:`Apply one schema to an entire extraction.`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`extraction_id`})}),_jsx(_components.td,{children:`uuid`}),_jsx(_components.td,{children:`Yes`}),_jsxs(_components.td,{children:[`ID of a saved extraction, or a batch extract job ID (auto-detected — see `,_jsx(_components.a,{href:`#multi-extraction`,children:`Multi-Extraction Mode`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`extraction_ids`})}),_jsx(_components.td,{children:`uuid[]`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Explicit list of extraction IDs to combine (see `,_jsx(_components.a,{href:`#multi-extraction`,children:`Multi-Extraction Mode`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`schema_config`})}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`XOR`}),_jsxs(_components.td,{children:[`Inline schema (see `,_jsx(_components.a,{href:`#schema-config`,children:`Schema Config`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`schema_config_id`})}),_jsx(_components.td,{children:`uuid`}),_jsx(_components.td,{children:`XOR`}),_jsx(_components.td,{children:`Reference to a saved schema configuration`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`async`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Default: `,_jsx(_components.code,{children:`false`})]})]})]})]}),_jsx(Heading,{level:`4`,id:`schema-config`,children:`Schema Config`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`input_schema`})}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`JSON Schema defining the structured data to extract`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`schema_prompt`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Natural language instructions to guide extraction`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`effort`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Enable extended reasoning for complex documents`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`agentic_confidence`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Return a per-field confidence score (0-1) in `,_jsx(_components.code,{children:`confidence`}),`, backed by additional verification of the extracted values. Billed 3 additional credits per page; must be enabled for your organization`]})]})]})]}),_jsx(Heading,{level:`3`,id:`response-200`,children:`Response (200)`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`schema_id`})}),_jsx(_components.td,{children:`uuid`}),_jsx(_components.td,{children:`Unique identifier for this schema version`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`version`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`Schema version number`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`schema_output`})}),_jsx(_components.td,{children:`object`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`{ values: {...}, citations: {...}, confidence: {...} }`}),` — `,_jsx(_components.code,{children:`values`}),` holds the extracted data, `,_jsx(_components.code,{children:`citations`}),` the source element IDs per field, and `,_jsx(_components.code,{children:`confidence`}),` a 0-1 score per field (mirrors the shape of `,_jsx(_components.code,{children:`values`}),`). With `,_jsx(_components.code,{children:`agentic_confidence: true`}),`, every value is additionally verified and the scores reflect that verification.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`extraction_ids`})}),_jsx(_components.td,{children:`uuid[]`}),_jsx(_components.td,{children:`Present when multiple extractions were combined — lists all source extraction IDs`})]})]})]}),_jsx(Heading,{level:`3`,id:`example-—-inline-schema`,children:`Example — Inline Schema`}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Python`,numberOfLines:`31`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`31`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` pulse `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Pulse`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client = Pulse(api_key=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`schema_result = client.schema(`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` extraction_id=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"abc123-def456-ghi789\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schema_config={`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"input_schema\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"properties\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"invoice_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"total_amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"vendor_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"line_items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"array\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"properties\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"required\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"invoice_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"total_amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema_prompt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Extract all invoice details including line items\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`print(schema_result.schema_output)`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`TypeScript`,numberOfLines:`21`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`21`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { PulseClient } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"pulse-ts-sdk\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`const`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` client = `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`new`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` PulseClient({ apiKey: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` });`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`const`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schemaResult = `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` client.schema({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` extraction_id: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"abc123-def456-ghi789\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schema_config: {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` input_schema: {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` properties: {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` invoice_number: { `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` total_amount: { `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` vendor_name: { `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` required: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"invoice_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"total_amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schema_prompt: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Extract all invoice details\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`console.log(schemaResult.schema_output);`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`curl`,numberOfLines:`17`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`17`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -X POST https://api.runpulse.com/schema \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"x-api-key: YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -d `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"extraction_id\": \"abc123-def456-ghi789\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema_config\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"input_schema\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"object\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"properties\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"invoice_number\": {\"type\": \"string\"},`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"total_amount\": {\"type\": \"number\"}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"required\": [\"invoice_number\", \"total_amount\"]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema_prompt\": \"Extract invoice details\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]}),_jsx(Heading,{level:`3`,id:`example-—-saved-config-reference`,children:`Example — Saved Config Reference`}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Python`,numberOfLines:`4`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`schema_result = client.schema(`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` extraction_id=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"abc123-def456-ghi789\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schema_config_id=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"config-uuid-123\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`curl`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -X POST https://api.runpulse.com/schema \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"x-api-key: YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -d `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'{\"extraction_id\": \"abc123-def456-ghi789\", \"schema_config_id\": \"config-uuid-123\"}'`})]}),`\n`]})})})]}),_jsx(Heading,{level:`3`,id:`example-response`,children:`Example Response`}),_jsx(CodeBlock,{filename:``,numberOfLines:`33`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`33`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"schema_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"schema-uuid-456\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"version\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"schema_output\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"values\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"invoice_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"INV-2024-001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total_amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1250.00`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"vendor_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Acme Corp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"line_items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Consulting Services\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1000.00`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Travel Expenses\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`250.00`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"citations\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"invoice_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"txt-3\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total_amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"tbl-1-r4c2\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"vendor_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"txt-5\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"line_items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"tbl-1-r1c0\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"tbl-1-r1c1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"tbl-1-r2c0\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"tbl-1-r2c1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"confidence\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"invoice_number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.98`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total_amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.95`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"vendor_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.97`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"line_items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.96`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.94`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.96`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.93`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(Heading,{level:`3`,id:`multi-extraction`,children:`Multi-Extraction Mode`}),_jsxs(_components.p,{children:[`Combine content from multiple documents and apply a single schema to the composite, producing `,_jsx(_components.strong,{children:`one merged result`}),`. This is useful when the data you need spans across several files (e.g., a loss summary in one file and exposure data in another).`]}),_jsx(Note,{children:_jsxs(_components.p,{children:[`This is different from `,_jsx(_components.a,{href:`/api-reference/endpoint/batch-overview#batch-schema`,children:`Batch Schema`}),`, which applies the same schema to each document `,_jsx(_components.strong,{children:`independently`}),` (one result per document). Use multi-extraction when you need to cross-reference or merge data from multiple source files into a single output.`]})}),_jsx(_components.p,{children:`There are two ways to trigger multi-extraction:`}),_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Batch extract auto-detection`}),` — Pass a batch extract `,_jsx(_components.code,{children:`batch_job_id`}),` as `,_jsx(_components.code,{children:`extraction_id`}),`. The system detects it as a batch parent and automatically combines all completed child extractions.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Explicit list`}),` — Pass an `,_jsx(_components.code,{children:`extraction_ids`}),` array with the specific extraction IDs to combine.`]}),`\n`]}),_jsxs(_components.p,{children:[`Citations in multi-extraction results use the `,_jsx(_components.code,{children:`extraction_id-bb_id`}),` format (e.g., `,_jsx(_components.code,{children:`abc123-txt-1`}),`) to disambiguate bounding boxes across source documents.`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Python`,numberOfLines:`36`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`36`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` pulse `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Pulse`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` pulse.types.schema_config `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` SchemaConfig`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client = Pulse(api_key=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Option 1: Pass a batch extract job ID (auto-detected)`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`schema_result = client.schema(`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` extraction_id=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\u003cbatch_job_id>\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schema_config=SchemaConfig(`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` input_schema={`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"properties\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"policy_period\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"exposure\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schema_prompt=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Combine data from both documents\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ),`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Option 2: Pass an explicit list of extraction IDs`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`schema_result = client.schema(`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` extraction_ids=[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"extraction-1-uuid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"extraction-2-uuid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schema_config=SchemaConfig(`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` input_schema={`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"properties\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"policy_period\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"exposure\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ),`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Response includes the list of source extraction IDs`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`print(schema_result.extraction_ids)`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`curl`,numberOfLines:`34`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`34`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Option 1: Batch extract ID (auto-detected)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -X POST https://api.runpulse.com/schema \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"x-api-key: YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -d `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"extraction_id\": \"\u003cbatch_job_id>\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema_config\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"input_schema\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"object\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"properties\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"policy_period\": {\"type\": \"string\"},`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"exposure\": {\"type\": \"number\"}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema_prompt\": \"Combine data from both documents\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Option 2: Explicit extraction IDs`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -X POST https://api.runpulse.com/schema \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"x-api-key: YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -d `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"extraction_ids\": [\"extraction-1-uuid\", \"extraction-2-uuid\"],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema_config\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"input_schema\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"object\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"properties\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"policy_period\": {\"type\": \"string\"},`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"exposure\": {\"type\": \"number\"}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]})]}),_jsxs(Tab,{title:`Split Mode`,id:`split-mode`,\"data-child-heading-ids\":`[\"request-2\",\"response-200-2\",\"example-%E2%80%94-per-topic-schemas\",\"example-response-2\"]`,children:[_jsx(Heading,{level:`3`,id:`request-2`,children:`Request`}),_jsxs(_components.p,{children:[`Apply different schemas to different page groups from a prior `,_jsx(_components.code,{children:`/split`}),` call.`]}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`split_id`})}),_jsx(_components.td,{children:`uuid`}),_jsx(_components.td,{children:`Yes`}),_jsxs(_components.td,{children:[`ID from a prior `,_jsx(_components.a,{href:`/api-reference/endpoint/split`,children:_jsx(_components.code,{children:`/split`})}),` call`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`split_schema_config`})}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`Per-topic schema configs (keys = topic names from split)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`async`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Default: `,_jsx(_components.code,{children:`false`})]})]})]})]}),_jsxs(_components.p,{children:[`Each topic in `,_jsx(_components.code,{children:`split_schema_config`}),`:`]}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`schema`})}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`XOR`}),_jsx(_components.td,{children:`JSON Schema for this topic`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`schema_prompt`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Additional extraction instructions`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`effort`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Enable extended reasoning`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`agentic_confidence`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Per-field confidence scores for this topic, backed by additional verification (+3 credits per page; must be enabled for your organization)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`schema_config_id`})}),_jsx(_components.td,{children:`uuid`}),_jsx(_components.td,{children:`XOR`}),_jsx(_components.td,{children:`Reference to a saved schema config`})]})]})]}),_jsx(Heading,{level:`3`,id:`response-200-2`,children:`Response (200)`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`schema_id`})}),_jsx(_components.td,{children:`uuid`}),_jsx(_components.td,{children:`Unique identifier for this schema version`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`split_id`})}),_jsx(_components.td,{children:`uuid`}),_jsx(_components.td,{children:`ID of the split that defined the page groups`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`results`})}),_jsx(_components.td,{children:`object`}),_jsxs(_components.td,{children:[`Per-topic results: `,_jsx(_components.code,{children:`{ \"topic\": { values: {...}, citations: {...}, confidence: {...} } }`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`input_schemas`})}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`Echo of the schemas applied, keyed by topic`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`errors`})}),_jsx(_components.td,{children:`object`}),_jsx(_components.td,{children:`Optional: per-topic errors if any topics failed`})]})]})]}),_jsx(Heading,{level:`3`,id:`example-—-per-topic-schemas`,children:`Example — Per-Topic Schemas`}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Python`,numberOfLines:`32`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`32`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` pulse `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Pulse`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`client = Pulse(api_key=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`schema_result = client.schema(`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` split_id=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"split-uuid-123\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` split_schema_config={`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"financial_statements\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"properties\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"revenue\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"expenses\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"net_income\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema_prompt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Extract financial data from statements\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"signatures\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"properties\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"signee_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"date_signed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` topic, result `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schema_result.results.items():`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` print(f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"{topic}: {result}\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`TypeScript`,numberOfLines:`32`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`32`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { PulseClient } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"pulse-ts-sdk\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`const`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` client = `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`new`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` PulseClient({ apiKey: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` });`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`const`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schemaResult = `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` client.schema({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` split_id: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"split-uuid-123\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` split_schema_config: {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` financial_statements: {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schema: {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` properties: {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` revenue: { `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` expenses: { `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schema_prompt: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Extract financial data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` signatures: {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` schema: {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` properties: {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` signee_name: { `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` date_signed: { `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` (`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`const`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [topic, result] `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`of`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Object.entries(schemaResult.results)) {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` console.log(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\"`${topic}:`\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, result);`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`curl`,numberOfLines:`15`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`15`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -X POST https://api.runpulse.com/schema \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"x-api-key: YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -d `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"split_id\": \"split-uuid-123\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"split_schema_config\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"financial_statements\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema\": {\"type\": \"object\", \"properties\": {\"revenue\": {\"type\": \"number\"}}},`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema_prompt\": \"Extract financial data\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"signatures\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"schema\": {\"type\": \"object\", \"properties\": {\"signee_name\": {\"type\": \"string\"}}}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})]}),_jsx(Heading,{level:`3`,id:`example-response-2`,children:`Example Response`}),_jsx(CodeBlock,{filename:``,numberOfLines:`19`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`19`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"schema_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"schema-uuid-789\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"split_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"split-uuid-123\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"results\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"financial_statements\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"values\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"revenue\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`5000000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"expenses\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`3200000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"citations\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"revenue\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"tbl-4-r2c3\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"confidence\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"revenue\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0.96`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"signatures\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"values\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"signee_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Jane Doe\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"date_signed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-01-15\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"citations\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"input_schemas\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"financial_statements\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"properties\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"revenue\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } } },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"signatures\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"properties\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"signee_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } } }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`error-responses`,children:`Error Responses`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Error`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:`Invalid request`}),_jsxs(_components.td,{children:[`Must provide `,_jsx(_components.code,{children:`extraction_id`}),`, `,_jsx(_components.code,{children:`extraction_ids`}),`, or `,_jsx(_components.code,{children:`split_id`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:`Invalid schema`}),_jsx(_components.td,{children:`Schema must follow JSON Schema / OpenAPI 3.0 format`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`agentic_confidence`}),` not enabled`]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`agentic_confidence: true`}),` requires the feature to be enabled for your organization`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`401`}),_jsx(_components.td,{children:`Unauthorized`}),_jsx(_components.td,{children:`Invalid or missing API key`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:`Not found`}),_jsx(_components.td,{children:`Extraction, batch job, or split not found`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`500`}),_jsx(_components.td,{children:`Processing error`}),_jsx(_components.td,{children:`Schema extraction failed`})]})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`best-practices`,children:`Best Practices`}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`Use effort mode for complex documents`,id:`use-effort-mode-for-complex-documents`,children:_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`effort: true`}),` for documents with complex layouts, tables, or when initial extraction quality is low.`]})}),_jsx(Accordion,{title:`Use agentic confidence when you need a trust signal per field`,id:`use-agentic-confidence-when-you-need-a-trust-signal-per-field`,children:_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`agentic_confidence: true`}),` to have every extracted field verified and scored: each field in `,_jsx(_components.code,{children:`confidence`}),` carries a 0-1 score you can route to review. It adds 3 credits per page and some latency, and must be enabled for your organization.`]})}),_jsx(Accordion,{title:`Provide schema_prompt for context`,id:`provide-schema-prompt-for-context`,children:_jsx(_components.p,{children:`Add natural language instructions to guide the extraction, especially for ambiguous fields.`})}),_jsx(Accordion,{title:`Use async for large schemas`,id:`use-async-for-large-schemas`,children:_jsxs(_components.p,{children:[`If your schema has many fields or the document is large, set `,_jsx(_components.code,{children:`async: true`}),` to avoid timeouts. See `,_jsx(_components.a,{href:`/api-reference/endpoint/poll`,children:`Polling for Results`}),`.`]})}),_jsx(Accordion,{title:`For multi-section documents, use split mode`,id:`for-multi-section-documents-use-split-mode`,children:_jsxs(_components.p,{children:[`First call `,_jsx(_components.a,{href:`/api-reference/endpoint/split`,children:_jsx(_components.code,{children:`/split`})}),` to get page groups, then use this endpoint with `,_jsx(_components.code,{children:`split_id`}),` + `,_jsx(_components.code,{children:`split_schema_config`}),`.`]})}),_jsx(Accordion,{title:`Combine data from multiple files with multi-extraction`,id:`combine-data-from-multiple-files-with-multi-extraction`,children:_jsxs(_components.p,{children:[`When the data you need spans multiple documents, use `,_jsx(_components.a,{href:`/api-reference/endpoint/batch-overview#batch-extract`,children:`Batch Extract`}),` to extract all files, then pass the `,_jsx(_components.code,{children:`batch_job_id`}),` as `,_jsx(_components.code,{children:`extraction_id`}),` to this endpoint. The system auto-detects the batch parent and combines content from all child extractions.`]})})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`related-endpoints`,children:`Related Endpoints`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Extract`,icon:`file-lines`,href:`/api-reference/endpoint/extract`,children:_jsx(_components.p,{children:`Extract content from a document`})}),_jsx(Card,{title:`Split Document`,icon:`scissors`,href:`/api-reference/endpoint/split`,children:_jsx(_components.p,{children:`Split a document into topic-based page groups`})}),_jsx(Card,{title:`Batch Processing`,icon:`layer-group`,href:`/api-reference/endpoint/batch-overview`,children:_jsx(_components.p,{children:`Apply schema across many documents in parallel`})})]})]})}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":{"config":{},"pageMetadata":{"title":"Schema Extraction","openapi":"api-reference/openapi.yml POST /schema","description":"Apply schema extraction to a previously saved extraction. The mode is\ninferred from the input:\n\n**Single mode** — Provide `extraction_id` + `schema_config` (or\n`schema_config_id`) to apply one schema to the entire document.\n\n**Multi-extraction mode** — Provide a batch extract ID as `extraction_id`\n(auto-detected) or an explicit `extraction_ids` list. The content from all\nextractions is combined and the schema is applied to the composite. Citations\nuse `extraction_id-bb_id` format to disambiguate across source documents.\n\n**Split mode** — Provide `split_id` + `split_schema_config` to apply\ndifferent schemas to different page groups from a prior `/split` call.\nEach topic can have its own schema, prompt, and effort setting.\n\nAn explicit root `properties` must contain at least one field; an empty object\nis refused with HTTP 400 before processing.\n\nCreates a versioned schema record that can be retrieved later.\nSet `async: true` to return immediately with a job_id for polling.\n\nSchema retention covers the job result and its saved schema files. When first-fetch deletion\nis enabled, a synchronous response or completed job poll that returns the full result inline\nconsumes it. A response containing a result URL preserves the output until its first download\nthrough `GET /results/{jobId}`. This policy uses API download URLs even when the org normally\nuses presigned storage URLs. Failed-job data is cleaned after the first failed poll when this\npolicy is enabled. The source extraction and other schema versions keep their own retention.\n\nTo apply schemas across many extractions or splits at once, see\n[Batch Schema](api:POST/batch/schema) or the\n[Batch Processing guide](/batch).","href":"/api-reference/endpoint/schema"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[{"title":"Async Mode","slug":"async-mode","depth":3,"children":[]}]},{"title":"Mode Reference","slug":"mode-reference","depth":2,"children":[{"title":"Request","slug":"request","depth":3,"children":[],"tabId":"single-mode"},{"title":"Schema Config","slug":"schema-config","depth":4,"children":[],"tabId":"single-mode"},{"title":"Response (200)","slug":"response-200","depth":3,"children":[],"tabId":"single-mode"},{"title":"Example — Inline Schema","slug":"example-—-inline-schema","depth":3,"children":[],"tabId":"single-mode"},{"title":"Example — Saved Config Reference","slug":"example-—-saved-config-reference","depth":3,"children":[],"tabId":"single-mode"},{"title":"Example Response","slug":"example-response","depth":3,"children":[],"tabId":"single-mode"},{"title":"Multi-Extraction Mode","slug":"multi-extraction","depth":3,"children":[],"tabId":"single-mode"},{"title":"Request","slug":"request-2","depth":3,"children":[],"tabId":"split-mode"},{"title":"Response (200)","slug":"response-200-2","depth":3,"children":[],"tabId":"split-mode"},{"title":"Example — Per-Topic Schemas","slug":"example-—-per-topic-schemas","depth":3,"children":[],"tabId":"split-mode"},{"title":"Example Response","slug":"example-response-2","depth":3,"children":[],"tabId":"split-mode"}]},{"title":"Error Responses","slug":"error-responses","depth":2,"children":[]},{"title":"Best Practices","slug":"best-practices","depth":2,"children":[]},{"title":"Related Endpoints","slug":"related-endpoints","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/pulseai/5215a343261c1e3e/api-fields.js"],"openApiReferenceData":{"operation":{"summary":"Extract structured data from a saved extraction or split","description":"Apply schema extraction to a previously saved extraction. The mode is\ninferred from the input:\n\n**Single mode** — Provide `extraction_id` + `schema_config` (or\n`schema_config_id`) to apply one schema to the entire document.\n\n**Multi-extraction mode** — Provide a batch extract ID as `extraction_id`\n(auto-detected) or an explicit `extraction_ids` list. The content from all\nextractions is combined and the schema is applied to the composite. Citations\nuse `extraction_id-bb_id` format to disambiguate across source documents.\n\n**Split mode** — Provide `split_id` + `split_schema_config` to apply\ndifferent schemas to different page groups from a prior `/split` call.\nEach topic can have its own schema, prompt, and effort setting.\n\nAn explicit root `properties` must contain at least one field; an empty object\nis refused with HTTP 400 before processing.\n\nCreates a versioned schema record that can be retrieved later.\nSet `async: true` to return immediately with a job_id for polling.\n\nSchema retention covers the job result and its saved schema files. When first-fetch deletion\nis enabled, a synchronous response or completed job poll that returns the full result inline\nconsumes it. A response containing a result URL preserves the output until its first download\nthrough `GET /results/{jobId}`. This policy uses API download URLs even when the org normally\nuses presigned storage URLs. Failed-job data is cleaned after the first failed poll when this\npolicy is enabled. The source extraction and other schema versions keep their own retention.\n\nTo apply schemas across many extractions or splits at once, see\n[Batch Schema](api:POST/batch/schema) or the\n[Batch Processing guide](/batch).","operationId":"extractSchema","tags":["Schema"],"requestBody":"3fbfdefc-b237-40ab-a37d-73ada7de077a","responses":{"200":"73a13cc4-de86-4f2e-b5c0-e185a0a5ad17","202":"7596480d-6925-4a32-8753-bf1b26679209","400":"79c28e9d-5133-40a6-9672-6470d3975bef","401":"2f62d644-c211-49dc-addc-f78be57682ba","404":"ec42c330-ce32-4267-a134-b796c4acff32","429":"b9ecfe1f-7262-4f69-93ef-23981b84a5eb","500":"faf9da80-011b-43e5-b797-8d5157600fbe","503":"b6a5a4ec-ca42-494e-a8b7-8e4754022fec"},"parameters":["49eb37c1-3d75-4bc9-8b54-834380273948"],"method":"post","type":"path","servers":["e1ef7834-5f16-4759-9585-bf90a3a29520"],"security":["3d136d9b-6b58-4a17-9f2d-f27756a950c2"],"path":"/schema","baseUrlOptions":["https://api.runpulse.com"],"title":"Extract structured data from a saved extraction or split","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"49eb37c1-3d75-4bc9-8b54-834380273948":{"name":"Pulse-Version","in":"header","required":false,"description":"The API version. These pages document version `1`.","schema":{"type":"string","default":"1","enum":["1"],"isRequired":false,"description":"The API version. These pages document version `1`.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for schema extraction. Mode is inferred from the input:\n- Provide `extraction_id` for single-mode or multi-extraction (auto-detected).\n If the ID belongs to a batch extract, its child extractions are combined automatically.\n- Provide `extraction_ids` for an explicit list of extractions to combine.\n- Provide `split_id` + `split_schema_config` for split-mode extraction.","properties":{"extraction_id":{"type":"string","format":"uuid","description":"ID of a saved extraction OR a batch extract job. When a batch extract ID is provided, the system auto-detects it and combines all completed child extractions into a single schema application.","uniqueKey":"extraction_id","typeLabel":"string\u003cuuid>"},"extraction_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"extraction_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Explicit list of extraction IDs to combine. The markdown and bounding boxes from all extractions are merged and the schema is applied to the composite content. Citations use `extraction_id-bb_id` format to disambiguate across source documents.","uniqueKey":"extraction_ids","typeLabel":"string\u003cuuid>[]"},"split_id":{"type":"string","format":"uuid","description":"ID of saved split (from a prior `/split` call). Use for split-mode schema extraction.","uniqueKey":"split_id","typeLabel":"string\u003cuuid>"},"schema_config":{"type":"object","description":"Inline schema configuration for single mode. Required (with extraction_id) if schema_config_id is not provided.","properties":{"input_schema":{"type":"object","description":"JSON Schema defining the structured data to extract.","uniqueKey":"schema_config.input_schema","typeLabel":"object"},"schema_prompt":{"type":"string","description":"Natural language prompt with additional extraction instructions.","uniqueKey":"schema_config.schema_prompt","typeLabel":"string"},"effort":{"type":"boolean","default":false,"description":"Enable extended reasoning for complex extractions.","uniqueKey":"schema_config.effort","typeLabel":"boolean"},"agentic_confidence":{"type":"boolean","default":false,"description":"Return a per-field confidence score (0-1) in `confidence`, backed by additional verification of the extracted values. Billed 3 additional credits per page. Must be enabled for your organization.","uniqueKey":"schema_config.agentic_confidence","typeLabel":"boolean"}},"uniqueKey":"schema_config","typeLabel":"object"},"schema_config_id":{"type":"string","format":"uuid","description":"Reference to a saved schema configuration for single mode. Use this instead of providing schema_config inline.","uniqueKey":"schema_config_id","typeLabel":"string\u003cuuid>"},"split_schema_config":{"type":"object","additionalProperties":{"type":"object","description":"Per-topic schema configuration.\nProvide EITHER inline schema fields OR schema_config_id reference.","properties":{"schema":{"type":"object","description":"JSON Schema for this topic.","uniqueKey":"split_schema_config.additionalProperties.schema","typeLabel":"object"},"schema_prompt":{"type":"string","description":"Additional instructions for this topic.","uniqueKey":"split_schema_config.additionalProperties.schema_prompt","typeLabel":"string"},"effort":{"type":"boolean","default":false,"description":"Enable extended reasoning.","uniqueKey":"split_schema_config.additionalProperties.effort","typeLabel":"boolean"},"agentic_confidence":{"type":"boolean","default":false,"description":"Return a per-field confidence score (0-1) in `confidence`, backed by additional verification of the extracted values. Billed 3 additional credits per page. Must be enabled for your organization.","uniqueKey":"split_schema_config.additionalProperties.agentic_confidence","typeLabel":"boolean"},"schema_config_id":{"type":"string","format":"uuid","description":"Reference to a saved schema configuration for this topic.","uniqueKey":"split_schema_config.additionalProperties.schema_config_id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"split_schema_config.additionalProperties","typeLabel":"object"},"description":"Per-topic schema configurations for split mode. Keys must match the topic names from the split. Each topic provides either inline schema or schema_config_id.","uniqueKey":"split_schema_config","typeLabel":"object"},"async":{"type":"boolean","default":false,"description":"If true, returns immediately with a job_id for polling via GET /job/{jobId}. Otherwise processes synchronously.","uniqueKey":"async","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"extraction_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","extraction_ids":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"split_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","schema_config":{"input_schema":{},"schema_prompt":"\u003cstring>","effort":false,"agentic_confidence":false},"schema_config_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","split_schema_config":{},"async":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"73a13cc4-de86-4f2e-b5c0-e185a0a5ad17":{"description":"Schema extraction result (when async=false or omitted). Shape depends on the mode used.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Response for single schema extraction mode.","required":["schema_id","version","schema_output"],"properties":{"schema_id":{"type":"string","format":"uuid","description":"Unique identifier for this schema version.","isRequired":true,"uniqueKey":"oneOf.0.schema_id","typeLabel":"string\u003cuuid>"},"version":{"type":"integer","minimum":1,"description":"Version number of this schema for the extraction.","isRequired":true,"uniqueKey":"oneOf.0.version","typeLabel":"integer"},"schema_output":{"type":"object","description":"Extracted values and citations.","properties":{"values":{"type":"object","description":"Extracted values matching the provided schema.","additionalProperties":true,"uniqueKey":"oneOf.0.schema_output.values","typeLabel":"object"},"citations":{"type":"object","description":"Citation references linking extracted values to source locations.","additionalProperties":true,"uniqueKey":"oneOf.0.schema_output.citations","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.0.schema_output","typeLabel":"object"},"extraction_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"oneOf.0.extraction_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Present when multiple extractions were combined (via batch extract auto-detection or explicit `extraction_ids` input). Lists all source extraction IDs that contributed to the result.","uniqueKey":"oneOf.0.extraction_ids","typeLabel":"string\u003cuuid>[]"},"credits_used":{"oneOf":[{"type":"number","format":"float","description":"Number of credits consumed by this request. Only present when the organization has the credit billing system enabled.","uniqueKey":"oneOf.0.credits_used.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","description":"Number of credits consumed by this request. Only present when the organization has the credit billing system enabled.","uniqueKey":"oneOf.0.credits_used.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.credits_used","typeLabel":"number\u003cfloat> | null"},"plan_info":{"type":"object","description":"Billing tier and cumulative usage information for the calling org, including this schema run.","properties":{"tier":{"type":"string","description":"Billing tier, e.g. `\"trial\"`, `\"growth\"`, `\"pulse_ultra_2\"`.","uniqueKey":"oneOf.0.plan_info.tier","typeLabel":"string"},"total_credits_used":{"type":"number","format":"float","description":"Total credits consumed by the organization to date, including this request. The primary billing metric going forward.","uniqueKey":"oneOf.0.plan_info.total_credits_used","typeLabel":"number\u003cfloat>"},"pages_used":{"type":"integer","minimum":0,"description":"Total pages processed by the organization to date, including this request. Kept for backward compatibility with clients that haven't migrated to `total_credits_used`.","uniqueKey":"oneOf.0.plan_info.pages_used","typeLabel":"integer"},"note":{"type":"string","description":"Optional human-readable note about billing state for this response (e.g. trial credits remaining). Omitted when no note applies.","uniqueKey":"oneOf.0.plan_info.note","typeLabel":"string"}},"uniqueKey":"oneOf.0.plan_info","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Response for split schema extraction mode.","required":["schema_id","split_id","results"],"properties":{"schema_id":{"type":"string","format":"uuid","description":"Unique identifier for this schema version.","isRequired":true,"uniqueKey":"oneOf.1.schema_id","typeLabel":"string\u003cuuid>"},"split_id":{"type":"string","format":"uuid","description":"ID of the split that defined the page groups.","isRequired":true,"uniqueKey":"oneOf.1.split_id","typeLabel":"string\u003cuuid>"},"results":{"type":"object","description":"Per-topic extraction results. Keys match the topic names from the split. Each value contains `values` and `citations`.","additionalProperties":{"type":"object","description":"Result of schema extraction with values and citations.","properties":{"values":{"type":"object","description":"Extracted values matching the provided schema.","additionalProperties":true,"uniqueKey":"oneOf.1.results.additionalProperties.values","typeLabel":"object"},"citations":{"type":"object","description":"Citation references linking extracted values to source locations.","additionalProperties":true,"uniqueKey":"oneOf.1.results.additionalProperties.citations","typeLabel":"object"}},"uniqueKey":"oneOf.1.results.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.1.results","typeLabel":"object"},"input_schemas":{"type":"object","description":"Echo of the schemas that were applied, keyed by topic.","additionalProperties":{"type":"object","uniqueKey":"oneOf.1.input_schemas.additionalProperties","typeLabel":"object"},"uniqueKey":"oneOf.1.input_schemas","typeLabel":"object"},"errors":{"type":"object","description":"Per-topic errors if any topics failed to process. Keys are topic names, values are error messages.","additionalProperties":{"type":"string","uniqueKey":"oneOf.1.errors.additionalProperties","typeLabel":"string"},"uniqueKey":"oneOf.1.errors","typeLabel":"object"},"credits_used":{"oneOf":[{"type":"number","format":"float","description":"Number of credits consumed by this request. Only present when the organization has the credit billing system enabled.","uniqueKey":"oneOf.1.credits_used.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","description":"Number of credits consumed by this request. Only present when the organization has the credit billing system enabled.","uniqueKey":"oneOf.1.credits_used.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.credits_used","typeLabel":"number\u003cfloat> | null"},"plan_info":{"type":"object","description":"Billing tier and cumulative usage information for the calling org, including this split-schema run.","properties":{"tier":{"type":"string","description":"Billing tier, e.g. `\"trial\"`, `\"growth\"`, `\"pulse_ultra_2\"`.","uniqueKey":"oneOf.1.plan_info.tier","typeLabel":"string"},"total_credits_used":{"type":"number","format":"float","description":"Total credits consumed by the organization to date, including this request. The primary billing metric going forward.","uniqueKey":"oneOf.1.plan_info.total_credits_used","typeLabel":"number\u003cfloat>"},"pages_used":{"type":"integer","minimum":0,"description":"Total pages processed by the organization to date, including this request. Kept for backward compatibility with clients that haven't migrated to `total_credits_used`.","uniqueKey":"oneOf.1.plan_info.pages_used","typeLabel":"integer"},"note":{"type":"string","description":"Optional human-readable note about billing state for this response (e.g. trial credits remaining). Omitted when no note applies.","uniqueKey":"oneOf.1.plan_info.note","typeLabel":"string"}},"uniqueKey":"oneOf.1.plan_info","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","description":"Returned instead of the full extraction result for large results, including documents with 70 or more pages and spreadsheet extractions. The `url` field is a single-use download link; fetch it once to retrieve the complete `ExtractResultCore` payload. Subsequent requests to the same URL return 410 Gone.","required":["is_url","url"],"properties":{"is_url":{"type":"boolean","description":"Always `true` for large document responses.","enum":[true],"isRequired":true,"uniqueKey":"oneOf.2.is_url","typeLabel":"enum\u003cboolean>"},"url":{"type":"string","description":"Single-use URL to download the full extraction result. After one successful download the resource is deleted and further requests return 410 Gone.","isRequired":true,"uniqueKey":"oneOf.2.url","typeLabel":"string"},"extraction_id":{"type":"string","format":"uuid","description":"Extraction identifier (when storage is enabled).","uniqueKey":"oneOf.2.extraction_id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"oneOf.2","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"schema_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","version":2,"schema_output":{"values":{},"citations":{}},"extraction_ids":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"credits_used":123,"plan_info":{"tier":"\u003cstring>","total_credits_used":123,"pages_used":1,"note":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7596480d-6925-4a32-8753-bf1b26679209":{"description":"Schema job accepted (when async=true)","content":{"application/json":{"schema":{"type":"object","description":"Acknowledgement returned when a request is submitted for asynchronous processing. Poll `GET /job/{job_id}` to check status and retrieve results.","required":["job_id","status"],"properties":{"job_id":{"type":"string","description":"Identifier assigned to the asynchronous job.","isRequired":true,"uniqueKey":"job_id","typeLabel":"string"},"status":{"type":"string","description":"Initial status reported by the server.","enum":["pending","processing","completed","failed","canceled"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable description of the accepted job.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"job_id":"\u003cstring>","status":"pending","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"79c28e9d-5133-40a6-9672-6470d3975bef":{"description":"Invalid request parameters or schema format","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"2f62d644-c211-49dc-addc-f78be57682ba":{"description":"Authentication failed or missing API key","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ec42c330-ce32-4267-a134-b796c4acff32":{"description":"Extraction or split not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b9ecfe1f-7262-4f69-93ef-23981b84a5eb":{"description":"Rate limited or schema processing is at capacity. Retry capacity refusals after the seconds in Retry-After.","headers":{"Retry-After":{"description":"Seconds to wait before retrying a capacity refusal.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","description":"A machine-readable request failure.","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code, e.g. `REQ_002`. Safe to branch on.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of what went wrong.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Additional context for the error when available, such as the offending field. Absent when there is nothing to add.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"faf9da80-011b-43e5-b797-8d5157600fbe":{"description":"Internal server error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b6a5a4ec-ca42-494e-a8b7-8e4754022fec":{"description":"Organization retention policy is temporarily unavailable. Processing and charging have not started; retry after the seconds in Retry-After.","headers":{"Retry-After":{"description":"Seconds to wait before retrying a retention-policy refusal.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","description":"A machine-readable request failure.","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","description":"Stable machine-readable error code, e.g. `REQ_002`. Safe to branch on.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of what went wrong.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Additional context for the error when available, such as the offending field. Absent when there is nothing to add.","uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3d136d9b-6b58-4a17-9f2d-f27756a950c2":{"ApiKey":{"type":"apiKey","in":"header","name":"x-api-key","x-fern-header":{"name":"apiKey","env":"PULSE_API_KEY"},"scopes":[],"schemeName":"ApiKey"}}},"servers":{"e1ef7834-5f16-4759-9585-bf90a3a29520":{"url":"https://api.runpulse.com","description":"Default Pulse API base URL"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","x-fern-header":{"name":"apiKey","env":"PULSE_API_KEY"},"scopes":[],"schemeName":"ApiKey"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"x-api-key"}],"title":"ApiKey"}]},"originalFileLocation":"api-reference/openapi.yml"},"subdomain":"pulseai","siteName":"Pulse API","title":"Schema Extraction - Pulse API","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/introduction","matchLevel":4},"v1":{"href":"/api-reference/endpoint/schema","matchLevel":0},"v1 (old)":{"href":"/v1/api-reference/endpoint/schema","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T01:39:50.803Z","originalFileLocation":"api-reference/endpoint/schema.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=\"Apply schema extraction to a previously saved extraction. The mode is inferred from the input: Single mode — Provide extraction_id + schema_config (or schema_config_id) to apply one schema to the entire document. Multi-extraction mode — Provide a batch extract ID as extraction_id (auto-detected) or an explicit extraction_ids list. The content from all extractions is combined and the schema is applied to the composite. Citations use extraction_id-bb_id format to disambiguate across source documents. Split mode — Provide split_id + split_schema_config to apply different schemas to different page groups from a prior /split call. Each topic can have its own schema, prompt, and effort setting. An explicit root properties must contain at least one field; an empty object is refused with HTTP 400 before processing. Creates a versioned schema record that can be retrieved later. Set async: true to return immediately with a job_id for polling. Schema retention covers the job result and its saved schema files. When first-fetch deletion is enabled, a synchronous response or completed job poll that returns the full result inline consumes it. A response containing a result URL preserves the output until its first download through GET /results/{jobId}. This policy uses API download URLs even when the org normally uses presigned storage URLs. Failed-job data is cleaned after the first failed poll when this policy is enabled. The source extraction and other schema versions keep their own retention. To apply schemas across many extractions or splits at once, see Batch Schema or the Batch Processing guide.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pulse 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/pulseai/EMicLlWnJwlz5Lxs/_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/pulseai/EMicLlWnJwlz5Lxs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pulseai/EMicLlWnJwlz5Lxs/_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/pulseai/EMicLlWnJwlz5Lxs/_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/pulseai/EMicLlWnJwlz5Lxs/_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/pulseai/EMicLlWnJwlz5Lxs/_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/pulseai/EMicLlWnJwlz5Lxs/_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/pulseai/EMicLlWnJwlz5Lxs/_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/pulseai/EMicLlWnJwlz5Lxs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Schema Extraction - Pulse API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Apply schema extraction to a previously saved extraction. The mode is inferred from the input: Single mode — Provide extraction_id + schema_config (or schema_config_id) to apply one schema to the entire document. Multi-extraction mode — Provide a batch extract ID as extraction_id (auto-detected) or an explicit extraction_ids list. The content from all extractions is combined and the schema is applied to the composite. Citations use extraction_id-bb_id format to disambiguate across source documents. Split mode — Provide split_id + split_schema_config to apply different schemas to different page groups from a prior /split call. Each topic can have its own schema, prompt, and effort setting. An explicit root properties must contain at least one field; an empty object is refused with HTTP 400 before processing. Creates a versioned schema record that can be retrieved later. Set async: true to return immediately with a job_id for polling. Schema retention covers the job result and its saved schema files. When first-fetch deletion is enabled, a synchronous response or completed job poll that returns the full result inline consumes it. A response containing a result URL preserves the output until its first download through GET /results/{jobId}. This policy uses API download URLs even when the org normally uses presigned storage URLs. Failed-job data is cleaned after the first failed poll when this policy is enabled. The source extraction and other schema versions keep their own retention. To apply schemas across many extractions or splits at once, see Batch Schema or the Batch Processing guide.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pulse API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.runpulse.com/api-reference/endpoint/schema\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pulseai.mintlify.site/_mintlify/api/og/v2?division=Pipeline+Steps\u0026amp;title=Schema+Extraction\u0026amp;description=Apply+schema+extraction+to+a+previously+saved+extraction.+The+mode+is%0Ainferred+from+the+input%3A%0A%0A**Single+mode**+%E2%80%94+Provide+%60extraction_id%60+%2B+%60schema_config%60+%28or%0A\u0026amp;theme=6dd969aac606de8f928cd444\u0026amp;signature=6ca71dfea484305797710ad8b5f09fb684947a227f4a57243fd11e37820948ed\">\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=\"Schema Extraction - Pulse API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Apply schema extraction to a previously saved extraction. The mode is inferred from the input: Single mode — Provide extraction_id + schema_config (or schema_config_id) to apply one schema to the entire document. Multi-extraction mode — Provide a batch extract ID as extraction_id (auto-detected) or an explicit extraction_ids list. The content from all extractions is combined and the schema is applied to the composite. Citations use extraction_id-bb_id format to disambiguate across source documents. Split mode — Provide split_id + split_schema_config to apply different schemas to different page groups from a prior /split call. Each topic can have its own schema, prompt, and effort setting. An explicit root properties must contain at least one field; an empty object is refused with HTTP 400 before processing. Creates a versioned schema record that can be retrieved later. Set async: true to return immediately with a job_id for polling. Schema retention covers the job result and its saved schema files. When first-fetch deletion is enabled, a synchronous response or completed job poll that returns the full result inline consumes it. A response containing a result URL preserves the output until its first download through GET /results/{jobId}. This policy uses API download URLs even when the org normally uses presigned storage URLs. Failed-job data is cleaned after the first failed poll when this policy is enabled. The source extraction and other schema versions keep their own retention. To apply schemas across many extractions or splits at once, see Batch Schema or the Batch Processing guide.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pulseai.mintlify.site/_mintlify/api/og/v2?division=Pipeline+Steps\u0026amp;title=Schema+Extraction\u0026amp;description=Apply+schema+extraction+to+a+previously+saved+extraction.+The+mode+is%0Ainferred+from+the+input%3A%0A%0A**Single+mode**+%E2%80%94+Provide+%60extraction_id%60+%2B+%60schema_config%60+%28or%0A\u0026amp;theme=6dd969aac606de8f928cd444\u0026amp;signature=6ca71dfea484305797710ad8b5f09fb684947a227f4a57243fd11e37820948ed\">\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/pulseai/EMicLlWnJwlz5Lxs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pulse API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3573f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.runpulse.com/api-reference/endpoint/schema\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/schema.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.runpulse.com/#organization\",\"name\":\"Pulse API\",\"url\":\"https://docs.runpulse.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pulseai/OJ897TEZf8bV6lk8/logo-icon.svg?fit=max\u0026auto=format\u0026n=OJ897TEZf8bV6lk8\u0026q=85\u0026s=1062873c6d0f5dd9971e379f2210c1cb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.runpulse.com#website\",\"name\":\"Pulse API\",\"url\":\"https://docs.runpulse.com\",\"publisher\":{\"@id\":\"https://docs.runpulse.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.runpulse.com/api-reference/endpoint/schema#webpage\",\"url\":\"https://docs.runpulse.com/api-reference/endpoint/schema\",\"name\":\"Schema Extraction\",\"description\":\"Apply schema extraction to a previously saved extraction. The mode is inferred from the input: Single mode — Provide extraction_id + schema_config (or schema_config_id) to apply one schema to the entire document. Multi-extraction mode — Provide a batch extract ID as extraction_id (auto-detected) or an explicit extraction_ids list. The content from all extractions is combined and the schema is applied to the composite. Citations use extraction_id-bb_id format to disambiguate across source documents. Split mode — Provide split_id + split_schema_config to apply different schemas to different page groups from a prior /split call. Each topic can have its own schema, prompt, and effort setting. An explicit root properties must contain at least one field; an empty object is refused with HTTP 400 before processing. Creates a versioned schema record that can be retrieved later. Set async: true to return immediately with a job_id for polling. Schema retention covers the job result and its saved schema files. When first-fetch deletion is enabled, a synchronous response or completed job poll that returns the full result inline consumes it. A response containing a result URL preserves the output until its first download through GET /results/{jobId}. This policy uses API download URLs even when the org normally uses presigned storage URLs. Failed-job data is cleaned after the first failed poll when this policy is enabled. The source extraction and other schema versions keep their own retention. To apply schemas across many extractions or splits at once, see Batch Schema or the Batch Processing guide.\",\"dateModified\":\"2026-11-13T01:39:50.803Z\",\"isPartOf\":{\"@id\":\"https://docs.runpulse.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.runpulse.com/api-reference/endpoint/schema#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.runpulse.com/api-reference/endpoint/schema#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pipeline Steps\",\"item\":\"https://docs.runpulse.com/api-reference/endpoint/pipeline-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Schema Extraction\",\"item\":\"https://docs.runpulse.com/api-reference/endpoint/schema\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.runpulse.com/api-reference/endpoint/schema#apireference\",\"headline\":\"Schema Extraction\",\"name\":\"Schema Extraction\",\"description\":\"Apply schema extraction to a previously saved extraction. The mode is inferred from the input: Single mode — Provide extraction_id + schema_config (or schema_config_id) to apply one schema to the entire document. Multi-extraction mode — Provide a batch extract ID as extraction_id (auto-detected) or an explicit extraction_ids list. The content from all extractions is combined and the schema is applied to the composite. Citations use extraction_id-bb_id format to disambiguate across source documents. Split mode — Provide split_id + split_schema_config to apply different schemas to different page groups from a prior /split call. Each topic can have its own schema, prompt, and effort setting. An explicit root properties must contain at least one field; an empty object is refused with HTTP 400 before processing. Creates a versioned schema record that can be retrieved later. Set async: true to return immediately with a job_id for polling. Schema retention covers the job result and its saved schema files. When first-fetch deletion is enabled, a synchronous response or completed job poll that returns the full result inline consumes it. A response containing a result URL preserves the output until its first download through GET /results/{jobId}. This policy uses API download URLs even when the org normally uses presigned storage URLs. Failed-job data is cleaned after the first failed poll when this policy is enabled. The source extraction and other schema versions keep their own retention. To apply schemas across many extractions or splits at once, see Batch Schema or the Batch Processing guide.\",\"url\":\"https://docs.runpulse.com/api-reference/endpoint/schema\",\"mainEntityOfPage\":{\"@id\":\"https://docs.runpulse.com/api-reference/endpoint/schema#webpage\"},\"dateModified\":\"2026-11-13T01:39:50.803Z\",\"publisher\":{\"@id\":\"https://docs.runpulse.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.runpulse.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pulse API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Pulse API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/schema.md","siteName":"Pulse API","nav":{"global":null,"versions":[{"version":"v2","default":true,"pages":[{"title":"v2","href":"/v2/introduction"}]},{"version":"v1","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Overview","href":"/api-reference/introduction"},{"title":"SDKs","href":"/api-reference/sdks"},{"title":"Async Processing","href":"/api-reference/async-processing"},{"title":"Structured Output Guidelines","href":"/api-reference/structured-output-guidelines"},{"title":"Bounding Boxes","href":"/api-reference/bounding-boxes"},{"title":"Supported File Types","href":"/api-reference/supported-file-types"},{"title":"Working with Large Documents","href":"/api-reference/large-documents"}]},{"group":"Pipeline Steps","pages":[{"title":"Pipeline Overview","href":"/api-reference/endpoint/pipeline-overview"},{"title":"Classify Document","openapi":"api-reference/openapi.yml POST /classify","href":"/api-reference/endpoint/classify"},{"title":"Extract File","openapi":"api-reference/openapi.yml POST /extract","description":"The primary endpoint for the Pulse API. Parses uploaded documents or remote\nfile URLs and returns rich markdown content with optional structured data\nextraction based on user-provided schemas and extraction options.\n\nSet `async: true` to return immediately with a job_id for polling via\nGET /job/{jobId}. Otherwise processes synchronously.\n\nFor large TIFFs with Pulse Ultra 2, submit a `file_url` ending in\n`.tif` or `.tiff` with `async: true`. Pulse downloads and processes\nthe image in bounded tiles after accepting the job. Results retain\nthe original TIFF page numbers and coordinates; internal tiles do\nnot increase the billed page count.\n\nWith Pulse Ultra 2, multi-page TIFF uploads also preserve every frame.\nPage ranges select original frames; billing counts the selected frames.\n\nTo process many files at once, see [Batch Extract](api:POST/batch/extract)\nor the [Batch Processing guide](/batch).","href":"/api-reference/endpoint/extract"},{"title":"Schema Extraction","openapi":"api-reference/openapi.yml POST /schema","href":"/api-reference/endpoint/schema"},{"title":"Tables","openapi":"api-reference/openapi.yml POST /tables","description":"Extract tables from a previously completed extraction. Processes the\nextraction's document content and returns structured table data.\n\nRequires the `tables_endpoint` feature flag to be enabled for your\norganization.\n\nSet `async: true` to return immediately with a `tables_id` for\npolling via `GET /job/{tables_id}`.\n\nTo extract tables from many extractions at once, see\n[Batch Tables](api:POST/batch/tables) or the\n[Batch Processing guide](/batch).","href":"/api-reference/endpoint/tables"},{"title":"Charts","openapi":"api-reference/openapi.yml POST /charts","href":"/api-reference/endpoint/charts"},{"title":"Split Document","openapi":"api-reference/openapi.yml POST /split","href":"/api-reference/endpoint/split"}]},{"group":"Batch \u0026 Pipelines","pages":[{"title":"Batch Processing","href":"/api-reference/endpoint/batch-overview"}]},{"group":"Forms","pages":[{"title":"Detect Form Fields","openapi":"api-reference/openapi.yml POST /form/detect","href":"/api-reference/endpoint/form-detect"},{"title":"Fill Form","openapi":"api-reference/openapi.yml POST /form/fill","href":"/api-reference/endpoint/form-fill"},{"title":"Clear Form","openapi":"api-reference/openapi.yml POST /form/clear","href":"/api-reference/endpoint/form-clear"}]},{"group":"Jobs, Results \u0026 Webhooks","pages":[{"title":"Poll Job","openapi":"api-reference/openapi.yml GET /job/{jobId}","href":"/api-reference/endpoint/poll"},{"title":"Cancel Job","openapi":"api-reference/openapi.yml DELETE /job/{jobId}","href":"/api-reference/endpoint/delete-job"},{"title":"Download Large Result","openapi":"api-reference/openapi.yml GET /results/{jobId}","href":"/api-reference/endpoint/large-results"},{"title":"Get Result Image","openapi":"api-reference/openapi.yml GET /results/{jobId}/images/{filename}","href":"/api-reference/endpoint/results-image"},{"title":"Download Result PDF","openapi":"api-reference/openapi.yml GET /results/{jobId}/pdf","href":"/api-reference/endpoint/results-pdf"},{"title":"Configure Webhooks","openapi":"api-reference/openapi.yml POST /webhook","href":"/api-reference/endpoint/webhook"}]},{"group":"Account \u0026 Usage","pages":[{"title":"Get Usage","openapi":"api-reference/openapi.yml GET /usage","href":"/api-reference/endpoint/usage"}]}]},{"tab":"Platform Reference","pages":[{"title":"Platform Reference","href":"/platform-reference/introduction"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/cookbooks/overview"}]}]},{"version":"v1 (old)","tag":"Old","pages":[{"title":"v1 (old)","href":"/v1/api-reference/endpoint/schema"}]}]},"basePath":"","title":"Schema Extraction - Pulse API","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-BjdIPj1P.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","AssistantPageLink-DEBW87tT.js"]}