JSON Schema (2020-12) for POST /v1/generations with this model; x-roles lists each input role's accepted media and limits
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ZeroGen API","description":"Generate images and video with every model in ZeroGen from your own servers.","colors":{"primary":"#18181B","light":"#E4E4E7","dark":"#18181B"},"logo":{"light":"https://mintcdn.com/zero-gen/W2GmhRNTfZqjZw9S/logo/light.svg?fit=max\u0026auto=format\u0026n=W2GmhRNTfZqjZw9S\u0026q=85\u0026s=35d09db4e90566e79f5af1c3d8ffb4be","dark":"https://mintcdn.com/zero-gen/W2GmhRNTfZqjZw9S/logo/dark.svg?fit=max\u0026auto=format\u0026n=W2GmhRNTfZqjZw9S\u0026q=85\u0026s=f4fcd821b66e08a00c2975e2458a4edc"},"favicon":"https://mintcdn.com/zero-gen/W2GmhRNTfZqjZw9S/favicon.svg?fit=max\u0026auto=format\u0026n=W2GmhRNTfZqjZw9S\u0026q=85\u0026s=46d5ff92806d6efc0a27dd88bce49b88","api":{"openapi":"openapi.json","playground":{"display":"simple"},"examples":{"languages":["curl","javascript","python"]}},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zero-gen","hasAudioNarration":false,"actualSubdomain":"zero-gen","customDomains":["docs.zerogen.com"],"gitSource":{"type":"github","owner":"zerogeneration","repo":"platform","deployBranch":"main","contentDirectory":"apps/api-docs","isPrivate":true,"mountPath":"","label":"","_id":"6adcf0cde85b0c9dcc4acad1"},"chroma":{"latestBuiltDeploymentHistoryId":"6add10119e1712172edc1116","collectionId":"5f92acff-b495-46a2-9c1b-66df9fb7c4b7","liveDeploymentHistoryId":"6add10119e1712172edc1116","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6add6db9cd8ebdc75e362e82","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API reference","count":13},{"language":"default","tag":"Guides","count":13},{"language":"default","tag":"Endpoints","count":12},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Generations","count":5},{"language":"default","tag":"Generate","count":4},{"language":"default","tag":"Conventions","count":4},{"language":"default","tag":"Uploads","count":3},{"language":"default","tag":"Account","count":2},{"language":"default","tag":"Models","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/models/read-a-model","slug":"/api-reference/models/read-a-model","pageMetadata":{"title":"Read a model","description":"One model and the JSON Schema (2020-12) that `POST /generations` validates its requests against. A deprecated model sends `Deprecation` and `Sunset`.\n\nNeeds the `models:read` scope.","deprecated":null,"version":null,"openapi":"/openapi.json get /models/{vendor}/{model}/{operation}","href":"/api-reference/models/read-a-model","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"One model and the JSON Schema (2020-12) that \", _jsx(_components.code, {\n children: \"POST /generations\"\n }), \" validates its requests against. A deprecated model sends \", _jsx(_components.code, {\n children: \"Deprecation\"\n }), \" and \", _jsx(_components.code, {\n children: \"Sunset\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Needs the \", _jsx(_components.code, {\n children: \"models:read\"\n }), \" scope.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Read a model","description":"One model and the JSON Schema (2020-12) that `POST /generations` validates its requests against. A deprecated model sends `Deprecation` and `Sunset`.\n\nNeeds the `models:read` scope.","deprecated":null,"version":null,"openapi":"/openapi.json get /models/{vendor}/{model}/{operation}","href":"/api-reference/models/read-a-model","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getModel","tags":["Models"],"summary":"Read a model","description":"One model and the JSON Schema (2020-12) that `POST /generations` validates its requests against. A deprecated model sends `Deprecation` and `Sunset`.\n\nNeeds the `models:read` scope.","parameters":["160afcdc-076f-4598-8b20-a5273e44dcb9","4360b50f-b50d-44b5-9d15-061935368af7","848ea807-49e1-4609-a998-9def9b6eead6"],"responses":{"200":"96d01632-92a3-48d4-8314-aae2b0d80006","400":"4ca8e18c-94bb-49dc-b37d-dffe7cab59f8","401":"589084d3-95bb-4473-8d1e-9920b53cef83","403":"243e865d-4a88-4e4d-b917-b7532453c162","404":"51cf01f2-e278-4aa7-ac24-a7e43c3bce9c","429":"453cb0e4-f442-41bf-9f26-3f10e056a6cf","500":"f26e3118-d8ed-43ae-b3e8-dc0b684f1faa","503":"c4b47b60-a7e1-45f4-b435-7fa3c864dd67"},"method":"get","type":"path","servers":["a6b98c3c-1283-400d-ad4f-17f195c5cbe1"],"security":["2878f9b5-d2e6-4cb9-ba92-fe02c38d64db"],"path":"/models/{vendor}/{model}/{operation}","baseUrlOptions":["https://api.zerogen.com/v1"],"title":"Read a model","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"160afcdc-076f-4598-8b20-a5273e44dcb9":{"name":"vendor","in":"path","required":true,"description":"The company that makes the model, such as `google`","schema":{"type":"string","isRequired":true,"description":"The company that makes the model, such as `google`","uniqueKey":"","typeLabel":"string"}},"4360b50f-b50d-44b5-9d15-061935368af7":{"name":"model","in":"path","required":true,"description":"The model, such as `nano-banana-2`","schema":{"type":"string","isRequired":true,"description":"The model, such as `nano-banana-2`","uniqueKey":"","typeLabel":"string"}},"848ea807-49e1-4609-a998-9def9b6eead6":{"name":"operation","in":"path","required":true,"description":"The operation, such as `generate`","schema":{"type":"string","isRequired":true,"description":"The operation, such as `generate`","uniqueKey":"","typeLabel":"string"}}},"responses":{"96d01632-92a3-48d4-8314-aae2b0d80006":{"description":"The model.","headers":{"Request-Id":{"description":"Identifies the request; quote it when contacting support.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"Requests the key may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer"}},"Deprecation":{"description":"When the model was deprecated, as @ followed by Unix seconds.","schema":{"type":"string"}},"Sunset":{"description":"When the deprecated model stops accepting requests (HTTP date).","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","maxLength":200,"pattern":"^[a-z0-9]+(?:[.-][a-z0-9]+)*\\/[a-z0-9]+(?:[.-][a-z0-9]+)*\\/[a-z0-9]+(?:[.-][a-z0-9]+)*$","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"capability":{"type":"string","enum":["image","video"],"isRequired":true,"uniqueKey":"capability","typeLabel":"enum\u003cstring>"},"operation":{"type":"string","enum":["generate","edit","inpaint","remix","text-to-vector","text-to-video","image-to-video","first-last-frame-to-video","reference-to-video","audio-to-video","video-to-video","extend-video","motion-control","clean-plate","render-to-real","hdr","outpaint","reference-video-to-video"],"isRequired":true,"uniqueKey":"operation","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["active","deprecated"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"sunsetAt":{"oneOf":[{"type":"string","description":"A deprecated model refuses new requests from this time","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","isRequired":true,"uniqueKey":"sunsetAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"A deprecated model refuses new requests from this time","isRequired":true,"uniqueKey":"sunsetAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sunsetAt","typeLabel":"string\u003cdate-time> | null"},"requestSchema":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"requestSchema.additionalProperties","typeLabel":"any"},"description":"JSON Schema (2020-12) for POST /v1/generations with this model; x-roles lists each input role's accepted media and limits","isRequired":true,"uniqueKey":"requestSchema","typeLabel":"object"}},"required":["id","name","capability","operation","status","sunsetAt","requestSchema"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","capability":"image","operation":"generate","status":"active","sunsetAt":"2023-11-07T05:31:56Z","requestSchema":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"4ca8e18c-94bb-49dc-b37d-dffe7cab59f8":{"description":"The request is malformed or invalid: invalid_request, validation_failed, model_unavailable or input_import_failed.","headers":{"Request-Id":{"description":"Identifies the request; quote it when contacting support.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"Requests the key may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,79}$","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"589084d3-95bb-4473-8d1e-9920b53cef83":{"description":"invalid_api_key: the key is missing, revoked or expired.","headers":{"Request-Id":{"description":"Identifies the request; quote it when contacting support.","schema":{"type":"string"}},"WWW-Authenticate":{"description":"Bearer realm=\"ZeroGen API\".","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,79}$","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"243e865d-4a88-4e4d-b917-b7532453c162":{"description":"permission_denied: the key lacks the scope this endpoint needs, the request came from a browser, or the API isn't enabled for the organization.","headers":{"Request-Id":{"description":"Identifies the request; quote it when contacting support.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"Requests the key may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,79}$","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"51cf01f2-e278-4aa7-ac24-a7e43c3bce9c":{"description":"not_found: no such resource for this caller, including a projectId the caller can't use.","headers":{"Request-Id":{"description":"Identifies the request; quote it when contacting support.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"Requests the key may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,79}$","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"453cb0e4-f442-41bf-9f26-3f10e056a6cf":{"description":"rate_limited: the key or its owner is over the rate limit, or the organization is at its running cap. Retry after Retry-After seconds.","headers":{"Request-Id":{"description":"Identifies the request; quote it when contacting support.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"Requests the key may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,79}$","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"f26e3118-d8ed-43ae-b3e8-dc0b684f1faa":{"description":"internal: something went wrong. Retry.","headers":{"Request-Id":{"description":"Identifies the request; quote it when contacting support.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"Requests the key may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,79}$","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"c4b47b60-a7e1-45f4-b435-7fa3c864dd67":{"description":"unavailable or pricing_unavailable: API keys, billing or pricing can't be reached right now. Retry.","headers":{"Request-Id":{"description":"Identifies the request; quote it when contacting support.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"Requests the key may make in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,79}$","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","retryable"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"2878f9b5-d2e6-4cb9-ba92-fe02c38d64db":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A ZeroGen API key: zg_ for a live key, zg_test_ for a test key.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"a6b98c3c-1283-400d-ad4f-17f195c5cbe1":{"url":"https://api.zerogen.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A ZeroGen API key: zg_ for a live key, zg_test_ for a test key.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A ZeroGen API key: zg_ for a live key, zg_test_ for a test key.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"zero-gen","siteName":"ZeroGen API","title":"Read a model - ZeroGen API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T20:07:49.842Z","originalFileLocation":"api-reference/models/read-a-model.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"One model and the JSON Schema (2020-12) that POST /generations validates its requests against. A deprecated model sends Deprecation and Sunset. Needs the models:read scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ZeroGen API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zero-gen/ben01azdM0Av99iT/_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/zero-gen/ben01azdM0Av99iT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zero-gen/ben01azdM0Av99iT/_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/zero-gen/ben01azdM0Av99iT/_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/zero-gen/ben01azdM0Av99iT/_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/zero-gen/ben01azdM0Av99iT/_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/zero-gen/ben01azdM0Av99iT/_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/zero-gen/ben01azdM0Av99iT/_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/zero-gen/ben01azdM0Av99iT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read a model - ZeroGen API\">\u003cmeta data-mint-head property=\"og:description\" content=\"One model and the JSON Schema (2020-12) that POST /generations validates its requests against. A deprecated model sends Deprecation and Sunset. Needs the models:read scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ZeroGen API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.zerogen.com/api-reference/models/read-a-model\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zero-gen.mintlify.app/_mintlify/api/og/v2?division=Models\u0026amp;title=Read+a+model\u0026amp;description=One+model+and+the+JSON+Schema+%282020-12%29+that+%60POST+%2Fgenerations%60+validates+its+requests+against.+A+deprecated+model+sends+%60Deprecation%60+and+%60Sunset%60.%0A%0ANeeds+the\u0026amp;theme=faa3a38b66501c3fd9e9fb87\u0026amp;signature=23379e9fb37a2472a70934914104cdd893aec2b3834e78e736254ad9f3439ab3\">\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=\"Read a model - ZeroGen API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"One model and the JSON Schema (2020-12) that POST /generations validates its requests against. A deprecated model sends Deprecation and Sunset. Needs the models:read scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zero-gen.mintlify.app/_mintlify/api/og/v2?division=Models\u0026amp;title=Read+a+model\u0026amp;description=One+model+and+the+JSON+Schema+%282020-12%29+that+%60POST+%2Fgenerations%60+validates+its+requests+against.+A+deprecated+model+sends+%60Deprecation%60+and+%60Sunset%60.%0A%0ANeeds+the\u0026amp;theme=faa3a38b66501c3fd9e9fb87\u0026amp;signature=23379e9fb37a2472a70934914104cdd893aec2b3834e78e736254ad9f3439ab3\">\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/zero-gen/ben01azdM0Av99iT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ZeroGen API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#18181B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.zerogen.com/api-reference/models/read-a-model\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/models/read-a-model.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.zerogen.com/#organization\",\"name\":\"ZeroGen API\",\"url\":\"https://docs.zerogen.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zero-gen/W2GmhRNTfZqjZw9S/logo/light.svg?fit=max\u0026auto=format\u0026n=W2GmhRNTfZqjZw9S\u0026q=85\u0026s=35d09db4e90566e79f5af1c3d8ffb4be\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.zerogen.com#website\",\"name\":\"ZeroGen API\",\"url\":\"https://docs.zerogen.com\",\"publisher\":{\"@id\":\"https://docs.zerogen.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.zerogen.com/api-reference/models/read-a-model#webpage\",\"url\":\"https://docs.zerogen.com/api-reference/models/read-a-model\",\"name\":\"Read a model\",\"description\":\"One model and the JSON Schema (2020-12) that POST /generations validates its requests against. A deprecated model sends Deprecation and Sunset. Needs the models:read scope.\",\"dateModified\":\"2026-10-24T20:07:49.842Z\",\"isPartOf\":{\"@id\":\"https://docs.zerogen.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.zerogen.com/api-reference/models/read-a-model#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.zerogen.com/api-reference/models/read-a-model#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.zerogen.com/api-reference/account/read-the-calling-key\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Models\",\"item\":\"https://docs.zerogen.com/api-reference/models/list-models\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Read a model\",\"item\":\"https://docs.zerogen.com/api-reference/models/read-a-model\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.zerogen.com/api-reference/models/read-a-model#apireference\",\"headline\":\"Read a model\",\"name\":\"Read a model\",\"description\":\"One model and the JSON Schema (2020-12) that POST /generations validates its requests against. A deprecated model sends Deprecation and Sunset. Needs the models:read scope.\",\"url\":\"https://docs.zerogen.com/api-reference/models/read-a-model\",\"mainEntityOfPage\":{\"@id\":\"https://docs.zerogen.com/api-reference/models/read-a-model#webpage\"},\"dateModified\":\"2026-10-24T20:07:49.842Z\",\"publisher\":{\"@id\":\"https://docs.zerogen.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.zerogen.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ZeroGen API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ZeroGen API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"Overview","href":"/api-reference/overview"}]},{"group":"Endpoints","pages":[{"group":"Account","pages":[{"title":"Read the calling key","deprecated":null,"version":null,"openapi":"/openapi.json get /me","href":"/api-reference/account/read-the-calling-key"},{"title":"Read the organization's balance","deprecated":null,"version":null,"openapi":"/openapi.json get /balance","href":"/api-reference/account/read-the-organizations-balance"}]},{"group":"Models","pages":[{"title":"List models","description":"The models this organization can run, one entry per model and operation. Read a model to get the JSON Schema its requests follow.\n\nNeeds the `models:read` scope.","deprecated":null,"version":null,"openapi":"/openapi.json get /models","href":"/api-reference/models/list-models"},{"title":"Read a model","deprecated":null,"version":null,"openapi":"/openapi.json get /models/{vendor}/{model}/{operation}","href":"/api-reference/models/read-a-model"}]},{"group":"Generations","pages":[{"title":"Quote a generation","description":"Validates and prices a request exactly as create would, and returns the maximum charge create would reserve. Nothing starts and nothing is held.\n\nNeeds the `generations:create` scope.","deprecated":null,"version":null,"openapi":"/openapi.json post /generations/quote","href":"/api-reference/generations/quote-a-generation"},{"title":"List generations","deprecated":null,"version":null,"openapi":"/openapi.json get /generations","href":"/api-reference/generations/list-generations"},{"title":"Create a generation","deprecated":null,"version":null,"openapi":"/openapi.json post /generations","href":"/api-reference/generations/create-a-generation"},{"title":"Read a generation","deprecated":null,"version":null,"openapi":"/openapi.json get /generations/{id}","href":"/api-reference/generations/read-a-generation"},{"title":"Cancel a generation","deprecated":null,"version":null,"openapi":"/openapi.json post /generations/{id}/cancel","href":"/api-reference/generations/cancel-a-generation"}]},{"group":"Uploads","pages":[{"title":"Create an upload","deprecated":null,"version":null,"openapi":"/openapi.json post /uploads","href":"/api-reference/uploads/create-an-upload"},{"title":"Read an upload","deprecated":null,"version":null,"openapi":"/openapi.json get /uploads/{id}","href":"/api-reference/uploads/read-an-upload"},{"title":"Complete an upload","deprecated":null,"version":null,"openapi":"/openapi.json post /uploads/{id}/complete","href":"/api-reference/uploads/complete-an-upload"}]}]}]}]},"title":"Read a model - ZeroGen API","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}