import { VlmRun } from "vlmrun";const client = new VlmRun({ apiKey: "<VLMRUN_API_KEY>" });const response = await client.hub.getSchema({ domain: "document.invoice" });console.log(response);
Description
This endpoint returns the JSON schema for a given domain, as defined in the VLM Run Hub.
Body
application/json
Request model for the hub schema: /v1/hub/schema
domain
string
required
The domain to get the schema for (e.g. document.invoice).
config
GenerationConfig · object
The VLM generation config to be used for //generate.
Hide child attributes
config.prompt
string | null
Additional user instructions appended to the application or skill prompt for this request.
config.detail
enum<string>
default:auto
The detail level to use for processing multimodal data.
Available options:
auto,
hi,
lo
config.json_schema
Json Schema · object | null
The overridden JSON schema to use for the model. To be used instead of the response model.
config.skills
AgentSkill · object[] | null
List of agent skills to enable for this generation request.
Hide child attributes
config.skills.type
string
default:skill_reference
The type of the skill. Use 'skill_reference' for DB-stored skills referenced by id/name. Use 'inline' to provide the skill as a base64-encoded zip bundle.
config.skills.skill_id
string | null
The unique identifier of the skill — a UUID or a name string (e.g., 'pillow', 'batch-processing').
config.skills.skill_name
string | null
Human-readable skill name for lookup (e.g., 'invoice-extraction'). Alternative to skill_id. Deprecated in favour of skill_id.
config.skills.skill_version
integerstring
default:latest
The version of the skill — an integer (e.g. 2) or 'latest'.
config.skills.version
integerstring
DEPRECATED: Use 'skill_version' instead. The version of the skill.
config.skills.name
string | null
Human-readable name for the inline skill (used for discovery and logging).
config.skills.description
string | null
Short description of what the inline skill does.
config.skills.source
InlineSkillSource · object | null
Source payload for inline skills. Contains the base64-encoded zip bundle with type, media_type, and data fields.
Hide child attributes
config.skills.source.data
string
required
Base64-encoded zip bundle containing the skill files.
config.skills.source.type
string
default:base64
Encoding type for the inline skill data. Currently only 'base64' is supported.
Allowed value: "base64"
config.skills.source.media_type
string
default:application/zip
MIME type of the skill bundle. Must be 'application/zip'.
config.skills.bundle
string | null
DEPRECATED: Use 'source.data' instead. Base64-encoded zip bundle containing the skill files (inline skills only).
config.gql_stmt
string | null
The GraphQL statement to use for the application. If provided, the response model will be generated from the GraphQL statement.
config.max_retries
integer
default:1
The maximum number of retries to use for the application.
config.max_tokens
integer
default:65535
The maximum number of tokens to use for the application.
config.temperature
number
default:0
The temperature to use for the application.
config.confidence
boolean
default:false
Include confidence scores in the response (included in the _metadata field).
config.grounding
boolean
default:false
Include grounding in the response (included in the _metadata field).
config.keyframes
boolean
default:false
Include keyframes in the video transcription response.
config.video_segment_duration
number | null
Duration in seconds for each video segment when chunking a video for transcription. Defaults to 150.0s.
Required range: x >= 1
config.video_frames_per_segment
integer | null
Number of frames to sample per video segment for captioning. Defaults to 8.
Required range: x >= 1
config.video_model
string | null
Model ID to use for video segment captioning (e.g. 'vlmrun-orion-1:fast'). When omitted, the server default is used.
config.video_input_mode
enum<string> | null
How to pass video to the captioning model: 'frames' extracts N JPEG frames per segment, 'native_video' sends the mp4 clip directly via video_url for models with native video understanding. Defaults to 'native_video' for Qwen deployment models, 'frames' for others.
Available options:
frames,
native_video
config.video_transcribe_audio
boolean
default:false
When True, transcribe the audio track to align segment boundaries. When False (default), skip ASR and use fixed-duration video segments only (visual-only captioning).
config.chat_context
string | null
Plain-text chat transcript (prior turns + current request) used to ground video captioning / transcription on what the user wants extracted.
config.page_indices
integer[] | null
0-indexed page indices to process for document files. If None, all pages are processed.
config.use_context_cache
boolean
default:true
Reuse cached representations of document/video content across calls. When True (default), the file is cached after the first call so repeated queries against the same file skip re-transmitting its contents. Set to False to always send the full content.
config.service_tier
enum<string> | null
Delivery tier for the request. 'standard'/'default' uses baseline rates, 'flex' applies a 50% discount with higher latency, 'priority' applies a 1.8x premium. When omitted (or 'auto'), the server default ('standard') applies. The chosen tier drives both billing and the latency/availability SLO.
Available options:
auto,
default,
standard,
flex,
priority
Response
Successful Response
Response model for the hub schema: /v1/hub/schema
domain
string
required
The domain to get the schema for.
description
string
required
The description of the domain.
schema_version
string
required
The specific version of the schema.
schema_hash
string
required
The sha256 hash of the schema.
gql_stmt
string
required
The GraphQL statement for the domain.
json_schema
Json Schema · object
required
The JSON schema for the domain.
json_sample
Json Sample · object | null
A sample JSON object that matches the schema.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VLM Run","description":"One API key for every visual model. Send a document or an image, get JSON back.","colors":{"primary":"#1F5ACA","light":"#4D8BFF","dark":"#102A56"},"logo":{"light":"https://mintcdn.com/autonomiai/0Yrk6nqaa_NlkPay/assets/logo/vlm-run-icon.svg?fit=max\u0026auto=format\u0026n=0Yrk6nqaa_NlkPay\u0026q=85\u0026s=fbea8392452b746e14273d7670a4f535","dark":"https://mintcdn.com/autonomiai/0Yrk6nqaa_NlkPay/assets/logo/vlm-run-icon-white.svg?fit=max\u0026auto=format\u0026n=0Yrk6nqaa_NlkPay\u0026q=85\u0026s=e58c8973ce1978adf1ce6359665a916a"},"favicon":"https://mintcdn.com/autonomiai/0Yrk6nqaa_NlkPay/assets/logo/vlm-run-icon.svg?fit=max\u0026auto=format\u0026n=0Yrk6nqaa_NlkPay\u0026q=85\u0026s=fbea8392452b746e14273d7670a4f535","api":{"openapi":["https://api.vlm.run/openapi.json","https://gateway.vlm.run/openapi.json"],"params":{"expanded":"all"},"playground":{"display":"simple"},"examples":{"languages":["python","javascript","ruby","curl"]}},"appearance":{"default":"light","strict":true},"background":{"color":{"light":"#FAFCFE","dark":"#010917"}},"navbar":{"links":[{"href":"mailto:support@vlm.run","label":"Contact"},{"href":"https://github.com/vlm-run/vlmrun-hub","label":"Hub"},{"href":"https://github.com/vlm-run/vlmrun-cookbook","label":"Cookbooks"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.vlm.run"}},"footer":{"socials":{"x":"https://x.com/vlmrun","github":"https://github.com/vlm-run/vlm-cookbook","linkedin":"https://www.linkedin.com/company/vlm-run"}},"seo":{"metatags":{"og:type":"website","og:site_name":"VLM Run","twitter:card":"summary_large_image","twitter:site":"@vlmrun"}},"fonts":{"heading":{"family":"Aeonik Pro","weight":400,"source":"fonts/AeonikPro-Regular.woff2","format":"woff2"},"body":{"family":"Aeonik Pro","weight":400,"source":"fonts/AeonikPro-Regular.woff2","format":"woff2"}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"dark-plus"}},"latex":true},"integrations":{"ga4":{"measurementId":"G-DKFNLZ8F83"}},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/autonomiai/0lq3Q9EPRCLt1zej/images/og-background.png?fit=max\u0026auto=format\u0026n=0lq3Q9EPRCLt1zej\u0026q=85\u0026s=010b9a1e01253f5f9d02474d89f85294"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"autonomiai","hasAudioNarration":false,"actualSubdomain":"autonomiai","customDomains":["docs.vlm.run"],"gitSource":{"type":"github","owner":"vlm-run","repo":"docs","deployBranch":"release","contentDirectory":"public","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af8a42574b4f0f02ee12098","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Orion","count":42},{"language":"default","tag":"Developers","count":35},{"language":"default","tag":"Gateway","count":31},{"language":"default","tag":"API reference","count":26},{"language":"default","tag":"SDKs","count":24},{"language":"default","tag":"Orion API","count":15},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Skills","count":14},{"language":"default","tag":"Python","count":12},{"language":"default","tag":"Node.js","count":12}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@import url('https://fonts.googleapis.com/css2?family=Geist+Mono:wght@400;500;600\u0026display=swap');:root{--vlm-primary: #1F5ACA;--vlm-primary-hover: #1848A2;--vlm-primary-vivid: #1265FF;--vlm-primary-mid: #1F5ACA;--vlm-primary-dark: #1848A2;--vlm-primary-light: #4D8BFF;--vlm-primary-border: #234D9F;--vlm-primary-tint: #E0EAFA;--vlm-primary-badge: #EEF2F9;--vlm-navy: #102A56;--vlm-navy-dark: #010917;--vlm-navy-mid: #102255;--vlm-muted: #576782;--vlm-surface: #FAFCFE;--vlm-border: #E1ECFA;--vlm-dark-border: #182231;--vlm-toc-active: #274275;--vlm-cap-blue: rgb(100, 151, 246);--vlm-cap-green: rgb(185, 246, 100);--vlm-cap-purple: rgb(177, 118, 255);--vlm-shadow-btn:\n rgba(0, 0, 0, 0.20) 0px -2px 0px 0px inset,\n rgba(0, 0, 0, 0.20) 0px 1px 2px 0px}:root{--vlm-docs-version: \"Docs updated 2026-08-15\"}body{color:var(--vlm-navy);-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}h1,h2,h3,h4,h5,h6{color:var(--vlm-navy);letter-spacing:0}#content>h2{margin-top:3rem;margin-bottom:1.5rem}#content>h3{margin-top:2.25rem;margin-bottom:1rem}#content>h4{margin-top:1.75rem;margin-bottom:0.75rem}#content>:is(h2,h3,h4):first-child{margin-top:0}#content>:is(h2,h3,h4)+table{margin-top:0}#content [data-table-wrapper=\"true\"]{margin-top:0;padding-top:0}#content [data-table-wrapper=\"true\"] table{margin-top:0}#content input.fold-rows{position:absolute;width:1px;height:1px;margin:0;opacity:0;pointer-events:none}#content input.fold-rows:not(:checked)+[data-table-wrapper=\"true\"] tbody tr:nth-child(n+7){display:none}#content input.fold-rows:not(:checked)+[data-table-wrapper=\"true\"]{position:relative}#content input.fold-rows:not(:checked)+[data-table-wrapper=\"true\"]::after{content:\"\";position:absolute;left:0;right:0;bottom:0;height:2.75rem;background:linear-gradient(to bottom, transparent, #fff);pointer-events:none}#content label.fold-rows-label{display:flex;justify-content:center;margin-top:0.25rem;margin-bottom:1.5rem;font-size:0.75rem;font-weight:500;color:var(--vlm-muted);cursor:pointer}#content input.fold-rows:checked+[data-table-wrapper=\"true\"]+label.fold-rows-label .when-closed,#content input.fold-rows:not(:checked)+[data-table-wrapper=\"true\"]+label.fold-rows-label .when-open{display:none}#content [data-component-part=\"tabs-list\"]{margin-top:1.75rem!important;gap:1.75rem!important}#content [data-component-part=\"tab-button\"]{padding-top:0.85rem!important;padding-bottom:0.7rem!important;border-bottom-width:2px!important;color:var(--vlm-muted)!important;font-size:1rem!important;font-weight:500!important;line-height:1.5rem!important}#content [data-component-part=\"tab-button\"]:hover{color:var(--vlm-navy)!important}#content [data-component-part=\"tab-button\"][data-active=\"true\"]{color:var(--vlm-navy)!important;border-bottom-color:var(--vlm-navy)!important}p,li{color:var(--vlm-muted);letter-spacing:-0.01em}#navigation-items .sidebar-group-header,#navigation-items .sidebar-group-header .sidebar-title{font-family:'Geist Mono', ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;font-size:11px;font-weight:500;letter-spacing:0.12em;text-transform:uppercase;color:var(--vlm-muted)}a{color:var(--vlm-primary);transition:color 200ms ease-out, opacity 200ms ease-out}a:hover{color:var(--vlm-primary-hover)}.prose a,article a{text-decoration-color:color-mix(in srgb, var(--vlm-primary) 35%, transparent);text-underline-offset:3px;transition:text-decoration-color 200ms ease-out, color 200ms ease-out}.prose a:hover,article a:hover{text-decoration-color:var(--vlm-primary)}#navbar a[href=\"https://app.vlm.run\"],.navbar a[href=\"https://app.vlm.run\"],header a[href=\"https://app.vlm.run\"]{border-radius:20px!important;border:1px solid var(--vlm-primary-border)!important;background-color:var(--vlm-primary-mid)!important;color:#fff!important;box-shadow:var(--vlm-shadow-btn);transition:transform 300ms ease-out,\n box-shadow 300ms ease-out,\n background-color 300ms ease-out,\n opacity 300ms ease-out}#navbar a[href=\"https://app.vlm.run\"]:hover,.navbar a[href=\"https://app.vlm.run\"]:hover,header a[href=\"https://app.vlm.run\"]:hover{transform:translateY(-1px);background-color:var(--vlm-primary-dark)!important;opacity:0.95}#navigation-items a,#sidebar a,nav[aria-label=\"Sidebar\"] a{color:var(--vlm-navy)}#navigation-items a:hover,#sidebar a:hover,nav[aria-label=\"Sidebar\"] a:hover{color:var(--vlm-primary)}#navigation-items a[aria-current=\"page\"],#navigation-items a[data-active=\"true\"],#sidebar a[aria-current=\"page\"],#sidebar a[data-active=\"true\"],nav[aria-label=\"Sidebar\"] a[aria-current=\"page\"]{color:var(--vlm-primary)!important;font-weight:500}#navigation-items li li>a,#navigation-items li li>div>a,#navigation-items li li>button,#navigation-items li li>div>button{padding-left:2.5rem!important}#navigation-items li li li>a,#navigation-items li li li>div>a,#navigation-items li li li>button,#navigation-items li li li>div>button{padding-left:3.5rem!important}#content-side-layout:has(#table-of-contents){width:max-content!important;max-width:13rem!important;margin-left:0!important;margin-right:0.75rem!important;padding-right:0!important;align-items:flex-end!important;flex:0 0 auto!important;box-sizing:border-box!important}@media (min-width: 1280px){#content-area{width:auto!important;max-width:none!important;flex:1 1 auto!important;margin-left:0!important;margin-right:0!important;padding-left:2rem!important;padding-right:2rem!important}#content-area:has(#content)>header,#content{width:100%;max-width:48rem;margin-left:auto!important;margin-right:auto!important}}#table-of-contents-layout{width:max-content!important;max-width:13rem!important;margin-left:auto!important;padding-left:0!important;padding-right:0!important}#table-of-contents{width:max-content!important;max-width:13rem!important}#content-side-layout:has(#table-of-contents) h2{font-family:'Aeonik Pro', ui-sans-serif, system-ui, sans-serif!important;font-size:0.8125rem!important;line-height:1.25rem!important;font-weight:500!important;letter-spacing:0.01em!important;color:var(--vlm-muted)!important}#table-of-contents-content a,#table-of-contents a{font-size:0.8125rem!important;line-height:1.25rem!important;color:var(--vlm-muted)!important}#content-area{width:auto!important;max-width:none!important}#content{max-width:48rem}#content li{text-wrap:pretty}#toc a[aria-current=\"true\"],#toc a[aria-current=\"location\"],#toc a[data-active=\"true\"],nav[aria-label=\"On this page\"] a[aria-current=\"true\"],nav[aria-label=\"On this page\"] a[aria-current=\"location\"],nav[aria-label=\"On this page\"] a[data-active=\"true\"],#table-of-contents a[aria-current=\"true\"],#table-of-contents a[aria-current=\"location\"],#table-of-contents a[data-active=\"true\"]{color:var(--vlm-toc-active)!important;font-weight:500;box-shadow:none!important;border:none!important;padding-left:0!important}.card,[class*=\"card\"][role=\"link\"],a.card{background-color:#ffffff;border:1px solid var(--vlm-border);border-radius:12px;transition:transform 300ms ease-out,\n border-color 300ms ease-out,\n box-shadow 300ms ease-out}.card:hover,[class*=\"card\"][role=\"link\"]:hover,a.card:hover{transform:translateY(-1px);border-color:var(--vlm-primary);box-shadow:0 4px 12px -4px color-mix(in srgb, var(--vlm-primary) 20%, transparent)}.card-demo{color:var(--vlm-primary-mid);background-color:var(--vlm-primary-tint);border-color:var(--vlm-primary-tint)}.callout-info,[role=\"note\"][data-type=\"info\"],[role=\"note\"][data-type=\"note\"]{background-color:var(--vlm-primary-badge);border-color:var(--vlm-border);color:var(--vlm-navy)}.callout-tip,[role=\"note\"][data-type=\"tip\"]{background-color:color-mix(in srgb, var(--vlm-cap-green) 18%, white);border-color:color-mix(in srgb, var(--vlm-cap-green) 45%, white);color:var(--vlm-navy)}pre,[class*=\"code-block\"] pre{border:0;border-radius:0;background:transparent}:not(pre)>code{background-color:#F0F2F5;color:var(--vlm-navy);padding:0.05rem 0.15rem;border-radius:4px;font-size:0.875em}#content a code,#header a code{color:inherit}#header .eyebrow{display:none}#content>:is(h2,h3,h4)+[data-table-wrapper]{margin-top:0!important;padding-top:0!important}#content>:is(h2,h3,h4)+[data-table-wrapper] table{margin-top:0}table{width:100%;margin:1.5rem 0;border:1px solid var(--vlm-border)!important;border-radius:6px;border-collapse:separate!important;border-spacing:0!important;background-color:#ffffff;font-size:0.875rem;color:var(--vlm-navy)}thead th{background-color:var(--vlm-surface);border:0!important;border-bottom:1px solid var(--vlm-border)!important;padding:0.7rem 1rem!important;font-family:'Geist Mono', ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;font-size:11px;font-weight:500;letter-spacing:0.12em;text-transform:uppercase;color:var(--vlm-navy);vertical-align:middle}thead th .unit-help{display:inline-flex;align-items:center;justify-content:center;width:0.875rem;height:0.875rem;margin-left:0.35rem;border:1px solid var(--vlm-border);border-radius:999px;background:#fff;color:var(--vlm-muted);font-family:'Aeonik Pro', ui-sans-serif, system-ui, sans-serif;font-size:0.625rem;font-weight:600;letter-spacing:0;text-transform:none;line-height:1;text-decoration:none;vertical-align:1px;cursor:help}thead th button:has(.unit-help){display:inline-flex;align-items:center;margin:0;padding:0;border:0;background:transparent;color:inherit;font:inherit;letter-spacing:0;text-transform:none;vertical-align:middle;cursor:help}thead tr:first-child th:first-child{border-top-left-radius:6px}thead tr:first-child th:last-child{border-top-right-radius:6px}tbody tr:last-child td:first-child{border-bottom-left-radius:6px}tbody tr:last-child td:last-child{border-bottom-right-radius:6px}thead tr+tr th{border-bottom:1px solid var(--vlm-border)!important;padding-top:0.5rem!important;padding-bottom:0.75rem!important;font-size:10.5px}thead th[align=\"left\"]{text-align:left}thead th[align=\"center\"]{text-align:center}thead th[align=\"right\"]{text-align:right}thead th code{background:transparent!important;color:var(--vlm-navy)!important;padding:0!important;font-size:inherit!important;letter-spacing:0.12em!important;text-transform:uppercase!important}tbody tr{background-color:#ffffff}tbody td{border:0!important;border-bottom:1px solid var(--vlm-border)!important;padding:0.7rem 1rem!important;vertical-align:middle;color:var(--vlm-navy);line-height:1.55}tbody td:has(br),tbody td:has(ul),tbody td:has(p){vertical-align:top}tbody td ul{margin:0;padding-left:1.25rem}tbody td li+li{margin-top:0.35em}tbody td li kbd{font-family:'Geist Mono', ui-monospace, monospace;font-weight:600;font-size:0.8125rem;line-height:1.3;letter-spacing:-0.01em;color:var(--vlm-navy);background:transparent;border:1px solid var(--vlm-border);padding:0.05rem 0.3rem;margin:0;border-radius:3px;white-space:nowrap;box-shadow:none!important;text-shadow:none;filter:none;-webkit-box-shadow:none!important}table code{white-space:nowrap}tbody tr:last-child td{border-bottom:0!important}thead th:first-child,tbody td:first-child{padding-left:1.125rem!important}thead th:last-child,tbody td:last-child{padding-right:1.125rem!important}.rotated-row-headers thead th:first-child,.rotated-row-headers tbody td:first-child{padding-left:0.5rem!important;padding-right:0.5rem!important}.rotated-row-headers tbody td:first-child{border-right:1px solid var(--vlm-border)!important}tbody td:first-child,tbody td[rowspan]+td{font-weight:500;color:var(--vlm-navy)}tbody td[align=\"center\"],tbody td[align=\"right\"]{font-weight:500;color:var(--vlm-navy)}table code{font-family:'Geist Mono', ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;font-size:13px;font-weight:500}td[align=\"left\"]{text-align:left}td[align=\"center\"]{text-align:center}td[align=\"right\"]{text-align:right}tbody td code{background:transparent!important;color:inherit!important;padding:0!important;font-size:inherit!important;border-radius:0!important;font-weight:inherit!important}.accordion table,[data-accordion-content] table{margin:0.75rem 0;font-size:0.8125rem}.accordion tbody td,[data-accordion-content] tbody td,.accordion thead th,[data-accordion-content] thead th{padding:0.75rem 1rem!important}.accordion thead th:first-child,[data-accordion-content] thead th:first-child,.accordion tbody td:first-child,[data-accordion-content] tbody td:first-child{padding-left:1.25rem!important}.accordion thead th:last-child,[data-accordion-content] thead th:last-child,.accordion tbody td:last-child,[data-accordion-content] tbody td:last-child{padding-right:1.25rem!important}.gateway-models-catalog table{table-layout:fixed;width:100%;font-size:0.8125rem}.gateway-models-catalog thead th{padding:0.5rem 0.625rem!important;font-size:10px;letter-spacing:0.08em;line-height:1.35;white-space:normal;vertical-align:bottom}.gateway-models-catalog tbody td{padding:0.5rem 0.625rem!important;font-size:0.8125rem;line-height:1.45;vertical-align:top}.gateway-models-catalog thead th:first-child,.gateway-models-catalog tbody td:first-child{width:26%;padding-left:0.75rem!important;white-space:normal;word-break:break-word}.gateway-models-catalog thead th:nth-child(2),.gateway-models-catalog tbody td:nth-child(2){width:4.75rem;max-width:4.75rem;white-space:normal;word-break:break-word;hyphens:auto;text-align:center;font-size:0.75rem;line-height:1.35}.gateway-models-catalog table code{white-space:normal;word-break:break-word;font-size:0.75rem}.gateway-models-catalog tbody td:first-child a{word-break:break-word}.gateway-models-catalog thead th:last-child,.gateway-models-catalog tbody td:last-child{padding-right:0.75rem!important}html.dark table{background-color:transparent;border-color:var(--vlm-dark-border)!important}html.dark thead tr,html.dark thead tr th,html.dark tbody tr{background-color:transparent}html.dark thead th,html.dark tbody td{color:inherit;border-color:var(--vlm-dark-border)!important}.integration-hero{width:100%;aspect-ratio:1024 / 500;background-image:url('/assets/blog-backdrop.png');background-size:cover;background-position:center;border:1px solid var(--vlm-border);border-radius:8px;display:flex;align-items:center;justify-content:center;gap:4%;margin:1.5rem 0 2rem;overflow:hidden}.integration-hero-tile{width:17.6%;aspect-ratio:1 / 1;background-color:rgba(255, 255, 255, 0.96);border:1px solid var(--vlm-border);border-radius:12px;box-shadow:0 1px 2px rgba(16, 42, 86, 0.04),\n 0 4px 12px rgba(31, 90, 202, 0.05);overflow:hidden}.integration-hero-tile{display:flex;align-items:center;justify-content:center}.integration-hero-tile img,.integration-hero-tile svg{display:block;width:60%;height:60%;max-width:60%;margin:0!important;object-fit:contain;object-position:center}.integration-hero-tile:has(img[alt=\"n8n\"]) img{width:90%;height:90%;max-width:90%}.integration-hero-tile:has(img[alt=\"Zapier\"]) img{width:56%;height:56%;max-width:56%}.integration-hero-tile:has(img[alt=\"MongoDB\"]) img{width:88%;height:88%;max-width:88%}.integration-hero-tile:has(img[alt=\"Voxel51 FiftyOne\"]) img{width:68%;height:68%;max-width:68%}.platform-figure{position:relative;border:1px solid var(--vlm-border);border-radius:8px;padding:3.5% 3% 56px;margin:1.5rem 0 2rem;overflow:hidden;background-color:#ffffff}.platform-figure::before{content:\"\";position:absolute;inset:0;background-image:url('/images/platform-background.png');background-size:cover;background-position:center;background-repeat:no-repeat;opacity:0.6;pointer-events:none;z-index:0}.platform-figure>*,.platform-figure img{position:relative;z-index:1}.platform-figure img{display:block;width:100%;height:auto;border-radius:16px;border:1px solid var(--vlm-border);box-shadow:0 1px 2px rgba(16, 42, 86, 0.10),\n 0 12px 32px rgba(31, 90, 202, 0.14)}.platform-card-grid .card img,.platform-card-grid [class*=\"card\"][role=\"link\"] img{background-color:#ffffff;background-image:url('/images/platform-background.png');background-size:cover;background-position:center;background-repeat:no-repeat;padding:14px;box-sizing:border-box;border-radius:10px 10px 0 0;border:1px solid var(--vlm-border);border-bottom:0;box-shadow:0 1px 2px rgba(16, 42, 86, 0.05)}.domain-column{width:240px;display:inline-block}.function-column{width:240px;display:inline-block}.allowed-inputs-column{width:160px;display:inline-block}.description-column{width:100%;display:inline-block}.tag{padding:2px 8px;border-radius:12px;font-size:0.9em;font-weight:500;display:inline-block;margin-right:8px;margin-bottom:4px}.tag-document{background:color-mix(in srgb, var(--vlm-cap-green) 22%, white);color:#2F6B14}.tag-image{background:color-mix(in srgb, var(--vlm-cap-blue) 22%, white);color:var(--vlm-primary-dark)}.tag-video{background:color-mix(in srgb, var(--vlm-cap-purple) 22%, white);color:#5A2BB8}.tag-audio{background:var(--vlm-primary-badge);color:var(--vlm-primary-dark)}.tag-url{background:var(--vlm-primary-badge);color:var(--vlm-primary-dark)}.tag-ref{background:color-mix(in srgb, var(--vlm-cap-purple) 14%, white);color:#5A2BB8}.no-scrollbar{scrollbar-width:none;-ms-overflow-style:none}.no-scrollbar::-webkit-scrollbar{display:none}.glass{background:rgba(255, 255, 255, 0.05);border:1px solid rgba(255, 255, 255, 0.1)}.shadow-btn{box-shadow:var(--vlm-shadow-btn)}#footer{flex-wrap:wrap;row-gap:1.25rem}#footer::after{content:var(--vlm-docs-version, \"\");flex-basis:100%;order:99;font-family:'Geist Mono', ui-monospace, monospace;font-size:12px;letter-spacing:0.02em;color:var(--vlm-muted)}.hero-video{display:block;width:100%;height:auto;border-radius:6px;background:var(--vlm-navy-dark)}p:has(>.changelog-tag:first-child),span:has(>.changelog-tag:first-child){padding-left:88px;text-indent:-88px}.changelog-tag{display:inline-block;box-sizing:border-box;width:76px;margin-right:8px;padding:1px 0;text-align:center;text-indent:0;border:1px solid var(--vlm-border);border-radius:4px;background:var(--vlm-primary-badge);color:var(--vlm-muted);font-family:'Geist Mono', ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;font-size:11px;font-weight:500;letter-spacing:0.08em;line-height:1.5;text-transform:uppercase;vertical-align:1px}.support-dot{color:var(--vlm-primary-light)}html:not([data-legacy=\"1\"]) #navigation-items>div:has(a[href=\"/api-reference/structured-extraction\"]){display:none}"}],"page":{"pagePath":"api-reference/v1/hub/post-schema","slug":"/api-reference/v1/hub/post-schema","pageMetadata":{"title":"Get schema for domain","openapi":"https://api.vlm.run/openapi.json POST /v1/hub/schema","description":"Get the JSON schema for a given domain (document.invoice, document.receipt, etc).","href":"/api-reference/v1/hub/post-schema"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get the JSON schema for a given domain (document.invoice, document.receipt, etc).\"\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`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`description`,children:`Description`}),`\n`,_jsxs(_components.p,{children:[`This endpoint returns the JSON schema for a given domain, as defined in the `,_jsx(_components.a,{href:`https://github.com/vlm-run/vlmrun-hub`,children:`VLM Run Hub`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"dark-plus"}},"config":{},"pageMetadata":{"title":"Get schema for domain","openapi":"https://api.vlm.run/openapi.json POST /v1/hub/schema","description":"Get the JSON schema for a given domain (document.invoice, document.receipt, etc).","href":"/api-reference/v1/hub/post-schema"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,RequestExample}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);return _jsxs(_Fragment,{children:[_jsxs(RequestExample,{children:[_jsx(CodeBlock,{filename:`Python`,numberOfLines:`6`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light dark-plus`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#24292e`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#B31D28`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`!`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`pip install vlmrun`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:` vlmrun.client `}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:` VLMRun`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`client `}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:` VLMRun(`}),_jsx(_components.span,{style:{color:`#E36209`,\"--shiki-dark\":`#9CDCFE`},children:`api_key`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#CE9178`},children:`\"\u003cVLMRUN_API_KEY>\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:` client.hub.get_schema(`}),_jsx(_components.span,{style:{color:`#E36209`,\"--shiki-dark\":`#9CDCFE`},children:`domain`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#CE9178`},children:`\"document.invoice\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Node.js`,numberOfLines:`5`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light dark-plus`,style:{backgroundColor:`#fff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#24292e`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#9CDCFE`},children:`VlmRun`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#CE9178`},children:` \"vlmrun\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#4FC1FF`},children:` client`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#569CD6`},children:` new`}),_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#DCDCAA`},children:` VlmRun`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`({ `}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#9CDCFE`},children:`apiKey:`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#CE9178`},children:` \"\u003cVLMRUN_API_KEY>\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:` });`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#005CC5`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#D73A49`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#9CDCFE`},children:` client`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#9CDCFE`},children:`hub`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#DCDCAA`},children:`getSchema`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`({ `}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#9CDCFE`},children:`domain:`}),_jsx(_components.span,{style:{color:`#032F62`,\"--shiki-dark\":`#CE9178`},children:` \"document.invoice\"`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:` });`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#9CDCFE`},children:`console`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#6F42C1`,\"--shiki-dark\":`#DCDCAA`},children:`log`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#9CDCFE`},children:`response`}),_jsx(_components.span,{style:{color:`#24292E`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`description`,children:`Description`}),`\n`,_jsxs(_components.p,{children:[`This endpoint returns the JSON schema for a given domain, as defined in the `,_jsx(_components.a,{href:`https://github.com/vlm-run/vlmrun-hub`,children:`VLM Run Hub`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"dark-plus"}},"config":{},"pageMetadata":{"title":"Get schema for domain","openapi":"https://api.vlm.run/openapi.json POST /v1/hub/schema","description":"Get the JSON schema for a given domain (document.invoice, document.receipt, etc).","href":"/api-reference/v1/hub/post-schema"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Description","slug":"description","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"Python","html":"\u003cpre class=\"shiki shiki-themes github-light dark-plus\" style=\"background-color:#fff;--shiki-dark-bg:#0B0C0E;color:#24292e;--shiki-dark:#D4D4D4\" language=\"python\">\u003ccode language=\"python\" numberOfLines=\"6\">\u003cspan class=\"line\">\u003cspan style=\"color:#B31D28;--shiki-light-font-style:italic;--shiki-dark:#F44747;--shiki-dark-font-style:inherit\">!\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">pip install vlmrun\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D73A49;--shiki-dark:#C586C0\">from\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\"> vlmrun.client \u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#C586C0\">import\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\"> VLMRun\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">client \u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\"> VLMRun(\u003c/span>\u003cspan style=\"color:#E36209;--shiki-dark:#9CDCFE\">api_key\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#CE9178\">\"\u0026#x3C;VLMRUN_API_KEY>\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">response \u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\"> client.hub.get_schema(\u003c/span>\u003cspan style=\"color:#E36209;--shiki-dark:#9CDCFE\">domain\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#CE9178\">\"document.invoice\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Node.js","html":"\u003cpre class=\"shiki shiki-themes github-light dark-plus\" style=\"background-color:#fff;--shiki-dark-bg:#0B0C0E;color:#24292e;--shiki-dark:#D4D4D4\" language=\"typescript\">\u003ccode language=\"typescript\" numberOfLines=\"5\">\u003cspan class=\"line\">\u003cspan style=\"color:#D73A49;--shiki-dark:#C586C0\">import\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\"> { \u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#9CDCFE\">VlmRun\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\"> } \u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#C586C0\">from\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#CE9178\"> \"vlmrun\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">;\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D73A49;--shiki-dark:#569CD6\">const\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#4FC1FF\"> client\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#D4D4D4\"> =\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#569CD6\"> new\u003c/span>\u003cspan style=\"color:#6F42C1;--shiki-dark:#DCDCAA\"> VlmRun\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">({ \u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#9CDCFE\">apiKey:\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#CE9178\"> \"\u0026#x3C;VLMRUN_API_KEY>\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\"> });\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D73A49;--shiki-dark:#569CD6\">const\u003c/span>\u003cspan style=\"color:#005CC5;--shiki-dark:#4FC1FF\"> response\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#D4D4D4\"> =\u003c/span>\u003cspan style=\"color:#D73A49;--shiki-dark:#C586C0\"> await\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#9CDCFE\"> client\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#9CDCFE\">hub\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#6F42C1;--shiki-dark:#DCDCAA\">getSchema\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">({ \u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#9CDCFE\">domain:\u003c/span>\u003cspan style=\"color:#032F62;--shiki-dark:#CE9178\"> \"document.invoice\"\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\"> });\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#24292E;--shiki-dark:#9CDCFE\">console\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#6F42C1;--shiki-dark:#DCDCAA\">log\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#9CDCFE\">response\u003c/span>\u003cspan style=\"color:#24292E;--shiki-dark:#D4D4D4\">);\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}}},"jsLinks":["/_mintlify/custom/autonomiai/a2d609d7d372c9af/unifygtm.js","/_mintlify/custom/autonomiai/12b17cdd767d0ac7/legacy.js"],"openApiReferenceData":{"operation":{"tags":["hub"],"summary":"Get Domain Schema","description":"Get the JSON schema for a given domain (document.invoice, document.receipt, etc).","operationId":"get_domain_schema_v1_hub_schema_post","requestBody":"f9af6612-6dc2-461d-83ad-8a99da3bf4b4","responses":{"200":"1c4dfed4-7245-41f7-8e89-5675a99649f1","422":"8dfe887e-65e9-4f45-8f3c-d9983e1f8108"},"method":"post","type":"path","servers":[],"security":[],"path":"/v1/hub/schema","baseUrlOptions":[],"title":"Get Domain Schema","codeSamples":[],"requestExampleLanguages":["python","javascript","ruby","bash"],"requiredOnlyExamples":false,"requestExamples":[{"dropdown":false,"language":"python","code":{"type":"pre","key":null,"ref":null,"props":{"className":"shiki shiki-themes github-light dark-plus","style":{"backgroundColor":"#fff","--shiki-dark-bg":"#0B0C0E","color":"#24292e","--shiki-dark":"#D4D4D4"},"language":"python","children":{"type":"code","key":null,"ref":null,"props":{"language":"python","numberOfLines":"6","children":[{"type":"span","key":"0","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#B31D28","--shiki-light-font-style":"italic","--shiki-dark":"#F44747","--shiki-dark-font-style":"inherit"},"children":"!"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":"pip install vlmrun"}}]}},"\n",{"type":"span","key":"2","ref":null,"props":{"className":"line","children":null}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#C586C0"},"children":"from"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":" vlmrun.client "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#C586C0"},"children":"import"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":" VLMRun"}}]}},"\n",{"type":"span","key":"6","ref":null,"props":{"className":"line","children":null}},"\n",{"type":"span","key":"8","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":"client "}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#D4D4D4"},"children":"="}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":" VLMRun("}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#E36209","--shiki-dark":"#9CDCFE"},"children":"api_key"}},{"type":"span","key":"4","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#D4D4D4"},"children":"="}},{"type":"span","key":"5","ref":null,"props":{"style":{"color":"#032F62","--shiki-dark":"#CE9178"},"children":"\"\u003cVLMRUN_API_KEY>\""}},{"type":"span","key":"6","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":")"}}]}},"\n",{"type":"span","key":"10","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":"response "}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#D4D4D4"},"children":"="}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":" client.hub.get_schema("}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#E36209","--shiki-dark":"#9CDCFE"},"children":"domain"}},{"type":"span","key":"4","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#D4D4D4"},"children":"="}},{"type":"span","key":"5","ref":null,"props":{"style":{"color":"#032F62","--shiki-dark":"#CE9178"},"children":"\"document.invoice\""}},{"type":"span","key":"6","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":")"}}]}},"\n"]}}}},"filename":"Python"},{"dropdown":false,"language":"typescript","code":{"type":"pre","key":null,"ref":null,"props":{"className":"shiki shiki-themes github-light dark-plus","style":{"backgroundColor":"#fff","--shiki-dark-bg":"#0B0C0E","color":"#24292e","--shiki-dark":"#D4D4D4"},"language":"typescript","children":{"type":"code","key":null,"ref":null,"props":{"language":"typescript","numberOfLines":"5","children":[{"type":"span","key":"0","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#C586C0"},"children":"import"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":" { "}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#9CDCFE"},"children":"VlmRun"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":" } "}},{"type":"span","key":"4","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#C586C0"},"children":"from"}},{"type":"span","key":"5","ref":null,"props":{"style":{"color":"#032F62","--shiki-dark":"#CE9178"},"children":" \"vlmrun\""}},{"type":"span","key":"6","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":";"}}]}},"\n",{"type":"span","key":"2","ref":null,"props":{"className":"line","children":null}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#569CD6"},"children":"const"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#005CC5","--shiki-dark":"#4FC1FF"},"children":" client"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#D4D4D4"},"children":" ="}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#569CD6"},"children":" new"}},{"type":"span","key":"4","ref":null,"props":{"style":{"color":"#6F42C1","--shiki-dark":"#DCDCAA"},"children":" VlmRun"}},{"type":"span","key":"5","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":"({ "}},{"type":"span","key":"6","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#9CDCFE"},"children":"apiKey:"}},{"type":"span","key":"7","ref":null,"props":{"style":{"color":"#032F62","--shiki-dark":"#CE9178"},"children":" \"\u003cVLMRUN_API_KEY>\""}},{"type":"span","key":"8","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":" });"}}]}},"\n",{"type":"span","key":"6","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#569CD6"},"children":"const"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#005CC5","--shiki-dark":"#4FC1FF"},"children":" response"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#D4D4D4"},"children":" ="}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#D73A49","--shiki-dark":"#C586C0"},"children":" await"}},{"type":"span","key":"4","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#9CDCFE"},"children":" client"}},{"type":"span","key":"5","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":"."}},{"type":"span","key":"6","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#9CDCFE"},"children":"hub"}},{"type":"span","key":"7","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":"."}},{"type":"span","key":"8","ref":null,"props":{"style":{"color":"#6F42C1","--shiki-dark":"#DCDCAA"},"children":"getSchema"}},{"type":"span","key":"9","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":"({ "}},{"type":"span","key":"10","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#9CDCFE"},"children":"domain:"}},{"type":"span","key":"11","ref":null,"props":{"style":{"color":"#032F62","--shiki-dark":"#CE9178"},"children":" \"document.invoice\""}},{"type":"span","key":"12","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":" });"}}]}},"\n",{"type":"span","key":"8","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#9CDCFE"},"children":"console"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":"."}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#6F42C1","--shiki-dark":"#DCDCAA"},"children":"log"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":"("}},{"type":"span","key":"4","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#9CDCFE"},"children":"response"}},{"type":"span","key":"5","ref":null,"props":{"style":{"color":"#24292E","--shiki-dark":"#D4D4D4"},"children":");"}}]}},"\n"]}}}},"filename":"Node.js"}],"requestExampleType":"mdx","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"domain":{"type":"string","title":"Domain","description":"The domain to get the schema for (e.g. document.invoice).","isRequired":true,"uniqueKey":"domain","typeLabel":"string"},"config":{"properties":{"prompt":{"oneOf":[{"type":"string","title":"Prompt","description":"Additional user instructions appended to the application or skill prompt for this request.","uniqueKey":"config.prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Prompt","description":"Additional user instructions appended to the application or skill prompt for this request.","uniqueKey":"config.prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.prompt","typeLabel":"string | null"},"detail":{"type":"string","enum":["auto","hi","lo"],"title":"Detail","description":"The detail level to use for processing multimodal data.","default":"auto","uniqueKey":"config.detail","typeLabel":"enum\u003cstring>"},"json_schema":{"oneOf":[{"type":"object","title":"Json Schema","description":"The overridden JSON schema to use for the model. To be used instead of the response model.","additionalProperties":true,"uniqueKey":"config.json_schema.oneOf.0","typeLabel":"Json Schema · object"},{"type":"null","title":"Json Schema","description":"The overridden JSON schema to use for the model. To be used instead of the response model.","uniqueKey":"config.json_schema.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.json_schema","typeLabel":"Json Schema · object | null"},"skills":{"oneOf":[{"type":"array","items":{"properties":{"type":{"type":"string","title":"Type","description":"The type of the skill. Use 'skill_reference' for DB-stored skills referenced by id/name. Use 'inline' to provide the skill as a base64-encoded zip bundle.","default":"skill_reference","uniqueKey":"config.skills.oneOf.0.items.[INDEX].type","typeLabel":"string"},"skill_id":{"oneOf":[{"type":"string","title":"Skill Id","description":"The unique identifier of the skill — a UUID or a name string (e.g., 'pillow', 'batch-processing').","uniqueKey":"config.skills.oneOf.0.items.[INDEX].skill_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Skill Id","description":"The unique identifier of the skill — a UUID or a name string (e.g., 'pillow', 'batch-processing').","uniqueKey":"config.skills.oneOf.0.items.[INDEX].skill_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.skills.oneOf.0.items.[INDEX].skill_id","typeLabel":"string | null"},"skill_name":{"oneOf":[{"type":"string","title":"Skill Name","description":"Human-readable skill name for lookup (e.g., 'invoice-extraction'). Alternative to skill_id. Deprecated in favour of skill_id.","uniqueKey":"config.skills.oneOf.0.items.[INDEX].skill_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Skill Name","description":"Human-readable skill name for lookup (e.g., 'invoice-extraction'). Alternative to skill_id. Deprecated in favour of skill_id.","uniqueKey":"config.skills.oneOf.0.items.[INDEX].skill_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.skills.oneOf.0.items.[INDEX].skill_name","typeLabel":"string | null"},"skill_version":{"oneOf":[{"type":"integer","title":"Skill Version","description":"The version of the skill — an integer (e.g. 2) or 'latest'.","default":"latest","uniqueKey":"config.skills.oneOf.0.items.[INDEX].skill_version.oneOf.0","typeLabel":"integer"},{"type":"string","title":"Skill Version","description":"The version of the skill — an integer (e.g. 2) or 'latest'.","default":"latest","uniqueKey":"config.skills.oneOf.0.items.[INDEX].skill_version.oneOf.1","typeLabel":"string"}],"uniqueKey":"config.skills.oneOf.0.items.[INDEX].skill_version","typeLabel":"integer | string"},"version":{"oneOf":[{"type":"integer","title":"Version","description":"DEPRECATED: Use 'skill_version' instead. The version of the skill.","uniqueKey":"config.skills.oneOf.0.items.[INDEX].version.oneOf.0","typeLabel":"integer"},{"type":"string","title":"Version","description":"DEPRECATED: Use 'skill_version' instead. The version of the skill.","uniqueKey":"config.skills.oneOf.0.items.[INDEX].version.oneOf.1","typeLabel":"string"},{"type":"null","title":"Version","description":"DEPRECATED: Use 'skill_version' instead. The version of the skill.","uniqueKey":"config.skills.oneOf.0.items.[INDEX].version.oneOf.2","typeLabel":"null"}],"uniqueKey":"config.skills.oneOf.0.items.[INDEX].version","typeLabel":"integer | string | null"},"name":{"oneOf":[{"type":"string","title":"Name","description":"Human-readable name for the inline skill (used for discovery and logging).","uniqueKey":"config.skills.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"Human-readable name for the inline skill (used for discovery and logging).","uniqueKey":"config.skills.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.skills.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","description":"Short description of what the inline skill does.","uniqueKey":"config.skills.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"Short description of what the inline skill does.","uniqueKey":"config.skills.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.skills.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"source":{"oneOf":[{"type":"object","title":"InlineSkillSource","description":"Source payload for inline skills. Contains the base64-encoded zip bundle with type, media_type, and data fields.","required":["data"],"properties":{"data":{"type":"string","title":"Data","description":"Base64-encoded zip bundle containing the skill files.","isRequired":true,"uniqueKey":"config.skills.oneOf.0.items.[INDEX].source.oneOf.0.data","typeLabel":"string"},"type":{"type":"string","const":"base64","title":"Type","description":"Encoding type for the inline skill data. Currently only 'base64' is supported.","default":"base64","uniqueKey":"config.skills.oneOf.0.items.[INDEX].source.oneOf.0.type","typeLabel":"string"},"media_type":{"type":"string","title":"Media Type","description":"MIME type of the skill bundle. Must be 'application/zip'.","default":"application/zip","uniqueKey":"config.skills.oneOf.0.items.[INDEX].source.oneOf.0.media_type","typeLabel":"string"}},"uniqueKey":"config.skills.oneOf.0.items.[INDEX].source.oneOf.0","typeLabel":"InlineSkillSource · object"},{"type":"null","description":"Source payload for inline skills. Contains the base64-encoded zip bundle with type, media_type, and data fields.","uniqueKey":"config.skills.oneOf.0.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.skills.oneOf.0.items.[INDEX].source","typeLabel":"InlineSkillSource · object | null"},"bundle":{"oneOf":[{"type":"string","title":"Bundle","description":"DEPRECATED: Use 'source.data' instead. Base64-encoded zip bundle containing the skill files (inline skills only).","uniqueKey":"config.skills.oneOf.0.items.[INDEX].bundle.oneOf.0","typeLabel":"string"},{"type":"null","title":"Bundle","description":"DEPRECATED: Use 'source.data' instead. Base64-encoded zip bundle containing the skill files (inline skills only).","uniqueKey":"config.skills.oneOf.0.items.[INDEX].bundle.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.skills.oneOf.0.items.[INDEX].bundle","typeLabel":"string | null"}},"type":"object","title":"AgentSkill","description":"A modular capability that extends the agent's functionality.\n\nAgent Skills are reusable, filesystem-based resources that provide the agent\nwith domain-specific expertise: workflows, context, and best practices.\n\nEach skill packages instructions, metadata, and optional resources (scripts,\ntemplates, snippets) that the agent uses automatically when relevant.\n\nTwo modes are supported:\n\n1. **Referenced skills** (``type=\"skill_reference\"``) – Provide ``skill_id``\n (UUID or name) and optionally ``skill_version`` (integer or ``\"latest\"``).\n\n .. code-block:: json\n\n {\"type\": \"skill_reference\", \"skill_id\": \"pillow\", \"skill_version\": \"latest\"}\n\n2. **Inline skills** (``type=\"inline\"``) – Supply ``name``, ``description``,\n and a ``source`` object containing the base64-encoded zip bundle. The zip\n must contain exactly one ``SKILL.md`` file. No database lookup is required.\n\n .. code-block:: json\n\n {\n \"type\": \"inline\",\n \"name\": \"csv-insights\",\n \"description\": \"Summarize CSV files.\",\n \"source\": {\n \"type\": \"base64\",\n \"media_type\": \"application/zip\",\n \"data\": \"\u003cbase64-zip>\"\n }\n }\n\n Legacy format with flat ``bundle`` field is also accepted for backward\n compatibility.","uniqueKey":"config.skills.oneOf.0.items.[INDEX]","typeLabel":"AgentSkill · object"},"title":"Skills","description":"List of agent skills to enable for this generation request.","uniqueKey":"config.skills.oneOf.0","typeLabel":"AgentSkill · object[]"},{"type":"null","title":"Skills","description":"List of agent skills to enable for this generation request.","uniqueKey":"config.skills.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.skills","typeLabel":"AgentSkill · object[] | null"},"gql_stmt":{"oneOf":[{"type":"string","title":"Gql Stmt","description":"The GraphQL statement to use for the application. If provided, the response model will be generated from the GraphQL statement.","uniqueKey":"config.gql_stmt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Gql Stmt","description":"The GraphQL statement to use for the application. If provided, the response model will be generated from the GraphQL statement.","uniqueKey":"config.gql_stmt.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.gql_stmt","typeLabel":"string | null"},"max_retries":{"type":"integer","title":"Max Retries","description":"The maximum number of retries to use for the application.","default":1,"uniqueKey":"config.max_retries","typeLabel":"integer"},"max_tokens":{"type":"integer","title":"Max Tokens","description":"The maximum number of tokens to use for the application.","default":65535,"uniqueKey":"config.max_tokens","typeLabel":"integer"},"temperature":{"type":"number","title":"Temperature","description":"The temperature to use for the application.","default":0,"uniqueKey":"config.temperature","typeLabel":"number"},"confidence":{"type":"boolean","title":"Confidence","description":"Include confidence scores in the response (included in the `_metadata` field).","default":false,"uniqueKey":"config.confidence","typeLabel":"boolean"},"grounding":{"type":"boolean","title":"Grounding","description":"Include grounding in the response (included in the `_metadata` field).","default":false,"uniqueKey":"config.grounding","typeLabel":"boolean"},"keyframes":{"type":"boolean","title":"Keyframes","description":"Include keyframes in the video transcription response.","default":false,"uniqueKey":"config.keyframes","typeLabel":"boolean"},"video_segment_duration":{"oneOf":[{"type":"number","title":"Video Segment Duration","description":"Duration in seconds for each video segment when chunking a video for transcription. Defaults to 150.0s.","minimum":1,"uniqueKey":"config.video_segment_duration.oneOf.0","typeLabel":"number"},{"type":"null","title":"Video Segment Duration","description":"Duration in seconds for each video segment when chunking a video for transcription. Defaults to 150.0s.","uniqueKey":"config.video_segment_duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.video_segment_duration","typeLabel":"number | null"},"video_frames_per_segment":{"oneOf":[{"type":"integer","title":"Video Frames Per Segment","description":"Number of frames to sample per video segment for captioning. Defaults to 8.","minimum":1,"uniqueKey":"config.video_frames_per_segment.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Video Frames Per Segment","description":"Number of frames to sample per video segment for captioning. Defaults to 8.","uniqueKey":"config.video_frames_per_segment.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.video_frames_per_segment","typeLabel":"integer | null"},"video_model":{"oneOf":[{"type":"string","title":"Video Model","description":"Model ID to use for video segment captioning (e.g. 'vlmrun-orion-1:fast'). When omitted, the server default is used.","uniqueKey":"config.video_model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Video Model","description":"Model ID to use for video segment captioning (e.g. 'vlmrun-orion-1:fast'). When omitted, the server default is used.","uniqueKey":"config.video_model.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.video_model","typeLabel":"string | null"},"video_input_mode":{"oneOf":[{"type":"string","title":"Video Input Mode","description":"How to pass video to the captioning model: 'frames' extracts N JPEG frames per segment, 'native_video' sends the mp4 clip directly via video_url for models with native video understanding. Defaults to 'native_video' for Qwen deployment models, 'frames' for others.","enum":["frames","native_video"],"uniqueKey":"config.video_input_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Video Input Mode","description":"How to pass video to the captioning model: 'frames' extracts N JPEG frames per segment, 'native_video' sends the mp4 clip directly via video_url for models with native video understanding. Defaults to 'native_video' for Qwen deployment models, 'frames' for others.","uniqueKey":"config.video_input_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.video_input_mode","typeLabel":"enum\u003cstring> | null"},"video_transcribe_audio":{"type":"boolean","title":"Video Transcribe Audio","description":"When True, transcribe the audio track to align segment boundaries. When False (default), skip ASR and use fixed-duration video segments only (visual-only captioning).","default":false,"uniqueKey":"config.video_transcribe_audio","typeLabel":"boolean"},"chat_context":{"oneOf":[{"type":"string","title":"Chat Context","description":"Plain-text chat transcript (prior turns + current request) used to ground video captioning / transcription on what the user wants extracted.","uniqueKey":"config.chat_context.oneOf.0","typeLabel":"string"},{"type":"null","title":"Chat Context","description":"Plain-text chat transcript (prior turns + current request) used to ground video captioning / transcription on what the user wants extracted.","uniqueKey":"config.chat_context.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.chat_context","typeLabel":"string | null"},"page_indices":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"config.page_indices.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Page Indices","description":"0-indexed page indices to process for document files. If None, all pages are processed.","uniqueKey":"config.page_indices.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Page Indices","description":"0-indexed page indices to process for document files. If None, all pages are processed.","uniqueKey":"config.page_indices.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.page_indices","typeLabel":"integer[] | null"},"use_context_cache":{"type":"boolean","title":"Use Context Cache","description":"Reuse cached representations of document/video content across calls. When True (default), the file is cached after the first call so repeated queries against the same file skip re-transmitting its contents. Set to False to always send the full content.","default":true,"uniqueKey":"config.use_context_cache","typeLabel":"boolean"},"service_tier":{"oneOf":[{"type":"string","title":"Service Tier","description":"Delivery tier for the request. 'standard'/'default' uses baseline rates, 'flex' applies a 50% discount with higher latency, 'priority' applies a 1.8x premium. When omitted (or 'auto'), the server default ('standard') applies. The chosen tier drives both billing and the latency/availability SLO.","enum":["auto","default","standard","flex","priority"],"uniqueKey":"config.service_tier.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Service Tier","description":"Delivery tier for the request. 'standard'/'default' uses baseline rates, 'flex' applies a 50% discount with higher latency, 'priority' applies a 1.8x premium. When omitted (or 'auto'), the server default ('standard') applies. The chosen tier drives both billing and the latency/availability SLO.","uniqueKey":"config.service_tier.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.service_tier","typeLabel":"enum\u003cstring> | null"}},"type":"object","title":"GenerationConfig","description":"The VLM generation config to be used for /\u003cdtype>/generate.","uniqueKey":"config","typeLabel":"GenerationConfig · object"}},"type":"object","required":["domain"],"title":"HubSchemaRequest","description":"Request model for the hub schema: /v1/hub/schema","uniqueKey":"","typeLabel":"HubSchemaRequest · object"},"examples":{"Example":{"title":"Example","value":{"domain":"\u003cstring>","config":{"prompt":"\u003cstring>","detail":"auto","json_schema":{},"skills":[{"type":"skill_reference","skill_id":"\u003cstring>","skill_name":"\u003cstring>","skill_version":"latest","version":123,"name":"\u003cstring>","description":"\u003cstring>","source":{"data":"\u003cstring>","type":"base64","media_type":"application/zip"},"bundle":"\u003cstring>"}],"gql_stmt":"\u003cstring>","max_retries":1,"max_tokens":65535,"temperature":0,"confidence":false,"grounding":false,"keyframes":false,"video_segment_duration":2,"video_frames_per_segment":2,"video_model":"\u003cstring>","video_transcribe_audio":false,"chat_context":"\u003cstring>","page_indices":[123],"use_context_cache":true}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"1c4dfed4-7245-41f7-8e89-5675a99649f1":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"domain":{"type":"string","title":"Domain","description":"The domain to get the schema for.","isRequired":true,"uniqueKey":"domain","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"The description of the domain.","isRequired":true,"uniqueKey":"description","typeLabel":"string"},"schema_version":{"type":"string","title":"Schema Version","description":"The specific version of the schema.","isRequired":true,"uniqueKey":"schema_version","typeLabel":"string"},"schema_hash":{"type":"string","title":"Schema Hash","description":"The sha256 hash of the schema.","isRequired":true,"uniqueKey":"schema_hash","typeLabel":"string"},"gql_stmt":{"type":"string","title":"Gql Stmt","description":"The GraphQL statement for the domain.","isRequired":true,"uniqueKey":"gql_stmt","typeLabel":"string"},"json_schema":{"additionalProperties":true,"type":"object","title":"Json Schema","description":"The JSON schema for the domain.","isRequired":true,"uniqueKey":"json_schema","typeLabel":"Json Schema · object"},"json_sample":{"oneOf":[{"type":"object","title":"Json Sample","description":"A sample JSON object that matches the schema.","additionalProperties":true,"uniqueKey":"json_sample.oneOf.0","typeLabel":"Json Sample · object"},{"type":"null","title":"Json Sample","description":"A sample JSON object that matches the schema.","uniqueKey":"json_sample.oneOf.1","typeLabel":"null"}],"uniqueKey":"json_sample","typeLabel":"Json Sample · object | null"}},"type":"object","required":["domain","description","schema_version","schema_hash","gql_stmt","json_schema"],"title":"HubSchemaResponse","description":"Response model for the hub schema: /v1/hub/schema","uniqueKey":"","typeLabel":"HubSchemaResponse · object"},"examples":{"Example":{"title":"Example","value":{"domain":"\u003cstring>","description":"\u003cstring>","schema_version":"\u003cstring>","schema_hash":"\u003cstring>","gql_stmt":"\u003cstring>","json_schema":{},"json_sample":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"8dfe887e-65e9-4f45-8f3c-d9983e1f8108":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{}},"originalFileLocation":"https://api.vlm.run/openapi.json"},"subdomain":"autonomiai","siteName":"VLM Run","title":"Get schema for domain - VLM Run","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-07T16:11:41.091Z","originalFileLocation":"api-reference/v1/hub/post-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=\"Get the JSON schema for a given domain (document.invoice, document.receipt, etc).\">\u003cmeta data-mint-head name=\"application-name\" content=\"VLM Run\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/autonomiai/pD_ZZ-IBiToGpeSG/_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/autonomiai/pD_ZZ-IBiToGpeSG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/autonomiai/pD_ZZ-IBiToGpeSG/_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/autonomiai/pD_ZZ-IBiToGpeSG/_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/autonomiai/pD_ZZ-IBiToGpeSG/_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/autonomiai/pD_ZZ-IBiToGpeSG/_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/autonomiai/pD_ZZ-IBiToGpeSG/_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/autonomiai/pD_ZZ-IBiToGpeSG/_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/autonomiai/pD_ZZ-IBiToGpeSG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get schema for domain - VLM Run\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get the JSON schema for a given domain (document.invoice, document.receipt, etc).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VLM Run\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vlm.run/api-reference/v1/hub/post-schema\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://autonomiai.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Get+schema+for+domain\u0026amp;description=Get+the+JSON+schema+for+a+given+domain+%28document.invoice%2C+document.receipt%2C+etc%29.\u0026amp;theme=9e78e25362d3b3059041160c\u0026amp;signature=4f8432a372fc47ba4edd07ab2f5d69926e636c69d0334201af6d6df9148a46dc\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get schema for domain - VLM Run\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get the JSON schema for a given domain (document.invoice, document.receipt, etc).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://autonomiai.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Get+schema+for+domain\u0026amp;description=Get+the+JSON+schema+for+a+given+domain+%28document.invoice%2C+document.receipt%2C+etc%29.\u0026amp;theme=9e78e25362d3b3059041160c\u0026amp;signature=4f8432a372fc47ba4edd07ab2f5d69926e636c69d0334201af6d6df9148a46dc\">\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/autonomiai/pD_ZZ-IBiToGpeSG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VLM Run\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F5ACA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vlm.run/api-reference/v1/hub/post-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/v1/hub/post-schema.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VLM Run\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"VLM Run\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v1/hub/post-schema.md","siteName":"VLM Run","nav":{"global":null,"tabs":[{"tab":"Gateway","icon":"network-wired","groups":[{"group":"Overview","pages":[{"title":"Introduction","sidebarTitle":"Introduction","icon":"compass","href":"/gateway/introduction"},{"title":"Quickstart","icon":"rocket","href":"/gateway/quickstart"},{"title":"Authentication","icon":"key","href":"/gateway/authentication"}]},{"group":"Platform","pages":[{"title":"Pricing","icon":"dollar-sign","href":"/gateway/pricing"},{"title":"Rate Limits","icon":"bolt-lightning","href":"/gateway/rate-limits"},{"title":"Error Codes","icon":"circle-exclamation","href":"/gateway/error-codes"}]},{"group":"OpenAI Compatibility","pages":[{"title":"Visual Intelligence","icon":"eye","href":"/gateway/visual-intelligence"},{"title":"Models","icon":"table-list","href":"/gateway/models"},{"title":"Methods","icon":"list-check","href":"/gateway/methods"},{"title":"Response Formats","icon":"brackets-curly","href":"/gateway/response-formats"},{"title":"Supported Inputs","icon":"images","href":"/gateway/multimodal-inputs"},{"title":"Response Types","icon":"shapes","href":"/gateway/response-types"},{"title":"OpenAI SDK Compatibility","icon":"arrow-right-arrow-left","href":"/gateway/openai-compatibility"}]},{"group":"TypeSafe Compatibility","pages":[{"title":"System One","icon":"scale-balanced","href":"/gateway/system-one"},{"title":"Models","sidebarTitle":"TypeSafe models","icon":"cubes","href":"/gateway/typesafe-models"},{"title":"TypeSafe SDK Compatibility","icon":"arrow-right-arrow-left","href":"/gateway/jev-compatibility"}]},{"group":"Realtime","pages":[{"title":"Realtime","icon":"tower-broadcast","href":"/gateway/realtime"},{"title":"Realtime Frames","icon":"video","href":"/gateway/realtime-frames"},{"title":"Realtime System One","icon":"bolt","href":"/gateway/realtime-systemone"}]},{"group":"MCP","pages":[{"title":"MCP Server","sidebarTitle":"Overview","icon":"plug","href":"/gateway/mcp-server"},{"title":"MCP Authentication","sidebarTitle":"Authentication","icon":"key","href":"/gateway/mcp-authentication"},{"title":"Connect an Agent","sidebarTitle":"Connect an Agent","icon":"plug-circle-bolt","href":"/gateway/mcp-clients"},{"title":"MCP Tools","sidebarTitle":"Tools","icon":"wrench","href":"/gateway/mcp-tools"},{"title":"MCP Reference","sidebarTitle":"Reference","icon":"book","href":"/gateway/mcp-reference"}]},{"group":"Misc","pages":[{"title":"FAQ","icon":"message-lines","href":"/gateway/faq"},{"title":"Skills","icon":"wand-magic-sparkles","href":"/gateway/skills"},{"title":"Changelog","icon":"clock-rotate-left","href":"/gateway/changelog"}]}]},{"tab":"Orion","icon":"robot","groups":[{"group":"Overview","pages":[{"title":"Introduction","icon":"robot","href":"/agents/introduction"},{"title":"Chat with Orion","icon":"comments","href":"/agents/chat"},{"title":"Pricing","sidebarTitle":"Pricing","icon":"dollar-sign","href":"/pricing"}]},{"group":"Orion","pages":[{"title":"Toolsets","icon":"toolbox","href":"/agents/toolsets"},{"title":"Code Execution","icon":"terminal","href":"/agents/code-execution"}]},{"group":"Input \u0026 Outputs","pages":[{"title":"Multi-modal Inputs","icon":"file-upload","href":"/agents/inputs"},{"title":"Structured Responses","icon":"brackets-curly","href":"/agents/structured-responses"},{"title":"Multi-modal Artifacts","icon":"box-open","href":"/agents/artifacts"},{"title":"Supported Files","icon":"file","mode":"wide","href":"/supported-files"}]},{"group":"Skills","pages":[{"title":"Orion Skills","icon":"wand-magic-sparkles","href":"/skills/introduction"},{"title":"Quickstart","icon":"rocket","href":"/skills/quickstart"},{"title":"Reference","icon":"book","href":"/skills/reference"},{"group":"Use Skills","expanded":false,"pages":[{"title":"Model Request","icon":"image","href":"/skills/usage/generation"},{"title":"Agent Execution","icon":"robot","href":"/skills/usage/agent"},{"title":"Chat Completions","icon":"comments","href":"/skills/usage/chat"},{"title":"Version Pinning","icon":"thumbtack","href":"/skills/usage/version-pinning"}]},{"group":"Manage Skills","expanded":false,"pages":[{"title":"Create Skills","icon":"plus","href":"/skills/manage/create"},{"title":"List \u0026 Lookup","icon":"magnifying-glass","href":"/skills/manage/list-lookup"},{"title":"Update Skills","icon":"arrows-rotate","href":"/skills/manage/update"}]},{"group":"Skill Specification","expanded":false,"pages":[{"title":"Skill Structure","icon":"folder-tree","href":"/skills/spec/overview"},{"title":"SKILL.md","icon":"file-lines","href":"/skills/spec/skill-md"},{"title":"vlmrun.yaml","icon":"gears","href":"/skills/spec/vlmrun-yaml"},{"title":"schema.json","icon":"brackets-curly","href":"/skills/spec/schema-json"}]}]},{"group":"Platform","pages":[{"title":"Platform","sidebarTitle":"Overview","icon":"play","href":"/platform/overview"},{"title":"Chat","icon":"comments","href":"/platform/chat"},{"title":"Settings","icon":"gear","href":"/platform/settings"},{"title":"Webhooks","icon":"webhook","href":"/webhooks"}]},{"group":"Observability","pages":[{"title":"Observe","sidebarTitle":"Overview","icon":"chart-line","href":"/platform/observe/overview"},{"title":"Requests","icon":"arrow-right-arrow-left","href":"/platform/observe/requests"},{"title":"Executions","icon":"list-check","href":"/platform/observe/executions"},{"title":"Completions","icon":"comment","href":"/platform/observe/completions"},{"title":"Evaluations","icon":"chart-line","href":"/platform/observe/evaluations"}]},{"group":"Frameworks","pages":[{"title":"OpenAI Compatibility","icon":"plug","href":"/agents/integrations/integrations-openai-compatibility"},{"title":"Instructor Compatibility","icon":"code","href":"/agents/integrations/integrations-instructor"},{"title":"Mastra Compatibility","icon":"plug","href":"/agents/integrations/integrations-mastra"},{"title":"Pydantic AI Compatibility","icon":"code","href":"/agents/integrations/integrations-pydantic-ai"}]},{"group":"Integrations","pages":[{"title":"Zapier","icon":"bolt","href":"/integrations/integrations-zapier"},{"title":"n8n","icon":"gear","href":"/integrations/integrations-n8n"},{"title":"Voxel51 FiftyOne","icon":"eye","href":"/integrations/integrations-voxel51"},{"title":"MongoDB","icon":"database","href":"/integrations/integrations-mongodb"}]}]},{"tab":"Guides","icon":"book-open","groups":[{"group":"Gateway","pages":[{"title":"Document OCR","icon":"file-lines","href":"/gateway/guides/document-ocr"},{"title":"Word Boxes","icon":"highlighter","href":"/gateway/guides/word-boxes"},{"title":"Document Classification","icon":"folder-tree","href":"/gateway/guides/document-classification"},{"title":"Field Extraction","icon":"table-list","href":"/gateway/guides/systemone-field-extraction"}]},{"group":"Documents","pages":[{"title":"Parsing Documents","icon":"book","href":"/guides/doc-ai/guide-parsing-documents"},{"title":"Classifying Documents","icon":"tag","href":"/guides/doc-ai/guide-classifying-documents"},{"title":"Document Redaction \u0026 Edit","icon":"shield-check","href":"/guides/doc-ai/guide-document-redaction"},{"title":"Parsing Invoices","icon":"file-invoice","href":"/guides/doc-ai/guide-parsing-invoices"},{"title":"Parsing Intake Forms","icon":"user-plus","href":"/guides/doc-ai/guide-healthcare-parsing-intake-forms"},{"title":"Providing Feedback","icon":"thumbs-up","href":"/guides/feedback"}]},{"group":"Images","pages":[{"title":"Classifying Images","icon":"tag","href":"/guides/image-ai/guide-classifying-images"},{"title":"Cataloging Images","icon":"magnifying-glass","href":"/guides/image-ai/guide-cataloging-images"}]},{"group":"Video and audio","pages":[{"title":"Transcribing Video","icon":"video","href":"/guides/video-ai/guide-video-transcription"},{"title":"Transcribing Audio","icon":"headphones","href":"/guides/audio-ai/guide-audio-transcription"}]}]},{"tab":"API reference","icon":"server","anchors":[{"anchor":"Gateway API","icon":"network-wired","groups":[{"group":"OpenAI Compatible API","pages":[{"title":"Health","icon":"heartbeat","openapi":"https://gateway.vlm.run/openapi.json GET /health","href":"/gateway/api-reference/get-health"},{"title":"Chat Completions","icon":"comments","openapi":"https://gateway.vlm.run/openapi.json POST /openai/chat/completions","href":"/gateway/api-reference/post-chat-completions"},{"title":"List Models","icon":"table-list","openapi":"https://gateway.vlm.run/openapi.json GET /openai/models","href":"/gateway/api-reference/get-models"},{"title":"Get Model","icon":"cube","openapi":"https://gateway.vlm.run/openapi.json GET /openai/models/{model_id}","href":"/gateway/api-reference/get-model-by-id"},{"title":"Get Completion","icon":"receipt","openapi":"https://gateway.vlm.run/openapi.json GET /openai/completions/{completion_id}","href":"/gateway/api-reference/get-completion"},{"title":"Embeddings","icon":"vector-square","openapi":"https://gateway.vlm.run/openapi.json POST /openai/embeddings","href":"/gateway/api-reference/post-embeddings"},{"title":"Audio Transcriptions","icon":"microphone","openapi":"https://gateway.vlm.run/openapi.json POST /openai/audio/transcriptions","href":"/gateway/api-reference/post-audio-transcriptions"}]},{"group":"TypeSafe Compatible API","pages":[{"title":"System One","openapi":"https://gateway.vlm.run/openapi.json POST /typesafe/v1/systemone","icon":"scale-balanced","href":"/gateway/api-reference/post-systemone"},{"title":"List Models","openapi":"https://gateway.vlm.run/openapi.json GET /typesafe/v1/models","icon":"table-list","href":"/gateway/api-reference/get-typesafe-models"}]},{"group":"Realtime API","pages":[{"title":"Realtime Frames","icon":"video","href":"/gateway/api-reference/ws-realtime"},{"title":"Realtime System One","icon":"bolt","href":"/gateway/api-reference/ws-systemone"}]}]},{"anchor":"Orion API","icon":"robot","groups":[{"group":"Getting started","pages":[{"title":"Overview","icon":"book","href":"/api-reference"},{"title":"Health","openapi":"https://api.vlm.run/openapi.json GET /v1/health","href":"/api-reference/v1/health"}]},{"group":"Chat Completions","pages":[{"title":"Chat Completions","openapi":"https://api.vlm.run/openapi.json POST /v1/openai/chat/completions","href":"/api-reference/v1/post-chat-completions"},{"title":"List models","openapi":"https://api.vlm.run/openapi.json GET /v1/models","href":"/api-reference/v1/get-models"}]},{"group":"Generate","pages":[{"title":"Structured Extraction","href":"/api-reference/structured-extraction"},{"title":"Image → JSON","openapi":"https://api.vlm.run/openapi.json POST /v1/image/generate","href":"/api-reference/v1/post-image-generate"},{"title":"Doc → JSON","openapi":"https://api.vlm.run/openapi.json POST /v1/document/generate","href":"/api-reference/v1/post-document-generate"},{"title":"Audio → JSON","openapi":"https://api.vlm.run/openapi.json POST /v1/audio/generate","href":"/api-reference/v1/post-audio-generate"},{"title":"Video → JSON","openapi":"https://api.vlm.run/openapi.json POST /v1/video/generate","href":"/api-reference/v1/post-video-generate"},{"title":"Get Prediction by ID","openapi":"https://api.vlm.run/openapi.json GET /v1/predictions/{id}","href":"/api-reference/v1/predictions/get-predictions-by-id"},{"title":"Get Predictions","openapi":"https://api.vlm.run/openapi.json GET /v1/predictions","href":"/api-reference/v1/predictions/get-predictions-list"}]},{"group":"Agents","pages":[{"title":"Lookup Agent","openapi":"https://api.vlm.run/openapi.json POST /v1/agent/lookup","href":"/api-reference/v1/post-agent-lookup"},{"title":"List Agents","openapi":"https://api.vlm.run/openapi.json GET /v1/agent","href":"/api-reference/v1/get-agent"},{"title":"Create Agent","openapi":"https://api.vlm.run/openapi.json POST /v1/agent/create","href":"/api-reference/v1/post-agent-create"},{"title":"Execute Agent","openapi":"https://api.vlm.run/openapi.json POST /v1/agent/execute","href":"/api-reference/v1/post-agent-execute"},{"title":"Get Execution by ID","openapi":"https://api.vlm.run/openapi.json GET /v1/agent/executions/{id}","href":"/api-reference/v1/get-agent-executions-by-id"},{"title":"List Executions","openapi":"https://api.vlm.run/openapi.json GET /v1/agent/executions","href":"/api-reference/v1/get-agent-executions"}]},{"group":"Files","pages":[{"title":"Upload File","openapi":"https://api.vlm.run/openapi.json POST /v1/files","href":"/api-reference/v1/files/post-file-upload"},{"title":"Get File by ID","openapi":"https://api.vlm.run/openapi.json GET /v1/files/{file_id}","href":"/api-reference/v1/files/get-files-by-id"},{"title":"List Files","openapi":"https://api.vlm.run/openapi.json GET /v1/files","href":"/api-reference/v1/files/get-files-list"},{"title":"Delete File","openapi":"https://api.vlm.run/openapi.json DELETE /v1/files/{file_id}","href":"/api-reference/v1/files/delete-file"},{"title":"Get Artifact","openapi":"https://api.vlm.run/openapi.json GET /v1/artifacts","href":"/api-reference/v1/get-artifact-by-id"}]},{"group":"Skills","pages":[{"title":"List Skills","openapi":"https://api.vlm.run/openapi.json GET /v1/skills","href":"/api-reference/v1/skills/get-skills-list"},{"title":"Lookup Skill","openapi":"https://api.vlm.run/openapi.json POST /v1/skills/lookup","href":"/api-reference/v1/skills/post-skill-lookup"},{"title":"Get Skill","openapi":"https://api.vlm.run/openapi.json GET /v1/skills/{skill_id}","href":"/api-reference/v1/skills/get-skill-by-id"},{"title":"Create Skill","openapi":"https://api.vlm.run/openapi.json POST /v1/skills/create","href":"/api-reference/v1/skills/post-skill-create"},{"title":"Update Skill","openapi":"https://api.vlm.run/openapi.json POST /v1/skills/{skill_id}/update","href":"/api-reference/v1/skills/post-skill-update"},{"title":"Get Skill Download URL","openapi":"https://api.vlm.run/openapi.json GET /v1/skills/{skill_id}/download","href":"/api-reference/v1/skills/get-skill-download"}]},{"group":"Feedback","pages":[{"title":"Submit Feedback","openapi":"https://api.vlm.run/openapi.json POST /v1/feedback/submit","href":"/api-reference/v1/post-submit-feedback"}]}]}]},{"tab":"Developers","icon":"code","groups":[{"group":"Overview","pages":[{"title":"Getting Started","sidebarTitle":"Introduction","href":"/sdk-reference/getting-started"}]},{"group":"SDKs","pages":[{"group":"Python","expanded":false,"pages":[{"title":"SDK Overview","href":"/sdk-reference/components/overview"},{"title":"Client Reference","href":"/sdk-reference/components/client"},{"title":"client.agent","href":"/sdk-reference/components/agent"},{"title":"client.files","href":"/sdk-reference/components/files"},{"title":"client.models","href":"/sdk-reference/components/models"},{"title":"client.hub","href":"/sdk-reference/components/hub"},{"title":"client.image","href":"/sdk-reference/predictions/image"},{"title":"client.document","href":"/sdk-reference/predictions/document"},{"title":"client.audio","href":"/sdk-reference/predictions/audio"},{"title":"client.video","href":"/sdk-reference/predictions/video"},{"title":"client.predictions","href":"/sdk-reference/components/predictions"},{"title":"client.gateway","href":"/sdk-reference/components/gateway"}]},{"group":"Node.js","expanded":false,"pages":[{"title":"Getting Started","href":"/sdk-reference/node/getting-started"},{"title":"client","href":"/sdk-reference/node/components/client"},{"title":"client.agent","href":"/sdk-reference/node/components/agent"},{"title":"client.files","href":"/sdk-reference/node/components/files"},{"title":"client.models","href":"/sdk-reference/node/components/models"},{"title":"client.hub","href":"/sdk-reference/node/components/hub"},{"title":"client.image","href":"/sdk-reference/node/predictions/image"},{"title":"client.document","href":"/sdk-reference/node/predictions/document"},{"title":"client.audio","href":"/sdk-reference/node/predictions/audio"},{"title":"client.video","href":"/sdk-reference/node/predictions/video"},{"title":"client.predictions","href":"/sdk-reference/node/components/predictions"},{"title":"client.gateway","href":"/sdk-reference/node/components/gateway"}]}]},{"group":"CLI","pages":[{"title":"Getting Started","icon":"terminal","href":"/cli/getting-started"},{"title":"config","icon":"gear","href":"/cli/config"},{"title":"files","icon":"file","href":"/cli/files"},{"title":"skills","icon":"wand-magic-sparkles","href":"/cli/skills"}]},{"group":"CLI - Gateway","pages":[{"title":"gateway","sidebarTitle":"gw","icon":"network-wired","href":"/cli/gateway"},{"title":"chat","sidebarTitle":"gw chat","icon":"comments","href":"/cli/gateway/chat"},{"title":"systemone","sidebarTitle":"gw systemone","icon":"scale-balanced","href":"/cli/gateway/systemone"}]},{"group":"CLI - Orion","pages":[{"title":"chat","icon":"comments","href":"/cli/chat"},{"title":"execute","icon":"bolt","href":"/cli/execute"},{"title":"executions","icon":"clock-rotate-left","href":"/cli/executions"}]}]}]},"basePath":"","title":"Get schema for domain - VLM Run","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}