{
"error": {
"message": "This account is suspended, so it cannot send requests. Contact support. Request id REQUEST_ID.",
"type": "permission_error",
"param": null,
"code": "account_suspended",
"request_id": "REQUEST_ID"
}
}
{
"error": {
"message": "The model \"openai/gpt-4o-mini\" was not found in the live catalog.",
"type": "not_found_error",
"param": "model",
"code": "model_not_found",
"request_id": "REQUEST_ID"
}
}
{
"error": {
"message": "POST is not supported for /v1/models/openai/gpt-4o-mini in this release.",
"type": "invalid_request_error",
"param": null,
"code": "method_not_allowed",
"request_id": "REQUEST_ID"
}
}
{
"error": {
"message": "Rate limit reached for this key. Try again in 12 seconds. Request id REQUEST_ID.",
"type": "rate_limit_error",
"param": null,
"code": "rate_limit_exceeded",
"request_id": "REQUEST_ID"
}
}
{
"error": {
"message": "The server had an error while processing your request. Sorry about that! Quote the request id if you contact support.",
"type": "api_error",
"param": null,
"code": null,
"request_id": "REQUEST_ID"
}
}
{
"error": {
"message": "No provider is configured, so there is nothing to serve this request.",
"type": "api_error",
"param": null,
"code": "no_provider_configured",
"request_id": "REQUEST_ID"
}
}
Models
Retrieve a model
Everything the list carries for one model, plus the fields served only here: the model’s own description, the request parameters it accepts, and its deprecation and sunset dates where it has them.
A model id contains slashes and the whole of it is the identifier. Percent-encode it once, or send it unencoded; a double-encoded slash names no model and answers 404.
{
"error": {
"message": "This account is suspended, so it cannot send requests. Contact support. Request id REQUEST_ID.",
"type": "permission_error",
"param": null,
"code": "account_suspended",
"request_id": "REQUEST_ID"
}
}
{
"error": {
"message": "The model \"openai/gpt-4o-mini\" was not found in the live catalog.",
"type": "not_found_error",
"param": "model",
"code": "model_not_found",
"request_id": "REQUEST_ID"
}
}
{
"error": {
"message": "POST is not supported for /v1/models/openai/gpt-4o-mini in this release.",
"type": "invalid_request_error",
"param": null,
"code": "method_not_allowed",
"request_id": "REQUEST_ID"
}
}
{
"error": {
"message": "Rate limit reached for this key. Try again in 12 seconds. Request id REQUEST_ID.",
"type": "rate_limit_error",
"param": null,
"code": "rate_limit_exceeded",
"request_id": "REQUEST_ID"
}
}
{
"error": {
"message": "The server had an error while processing your request. Sorry about that! Quote the request id if you contact support.",
"type": "api_error",
"param": null,
"code": null,
"request_id": "REQUEST_ID"
}
}
{
"error": {
"message": "No provider is configured, so there is nothing to serve this request.",
"type": "api_error",
"param": null,
"code": "no_provider_configured",
"request_id": "REQUEST_ID"
}
}
A workspace API key in an Authorization: Bearer header. A missing header, a scheme other than Bearer, a key of the wrong shape, and a key we reject are all 401.
Everything the list carries for a model, plus the five fields served only when one model is asked for by name.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hopscotch","description":"OpenAI-compatible LLM router. One key, one endpoint, every model.","colors":{"primary":"#00786a","light":"#00c5a9","dark":"#00786a"},"logo":{"light":"https://mintcdn.com/unirouter/e-jU4qy0Y8gPhRZJ/logo/light.svg?fit=max\u0026auto=format\u0026n=e-jU4qy0Y8gPhRZJ\u0026q=85\u0026s=eb9901b22939c791c90369af09611ebe","dark":"https://mintcdn.com/unirouter/e-jU4qy0Y8gPhRZJ/logo/dark.svg?fit=max\u0026auto=format\u0026n=e-jU4qy0Y8gPhRZJ\u0026q=85\u0026s=22613b0632e285d26d92e43e064b95db","href":"/"},"favicon":{"light":"https://mintcdn.com/unirouter/e-jU4qy0Y8gPhRZJ/favicon/light.svg?fit=max\u0026auto=format\u0026n=e-jU4qy0Y8gPhRZJ\u0026q=85\u0026s=cddcf3547075243322e642a21f97d9eb","dark":"https://mintcdn.com/unirouter/e-jU4qy0Y8gPhRZJ/favicon/dark.svg?fit=max\u0026auto=format\u0026n=e-jU4qy0Y8gPhRZJ\u0026q=85\u0026s=613a4663bfe054aab755b5eae7c3c7b8"},"api":{"openapi":"api-reference/openapi.public.json","playground":{"display":"interactive"}},"appearance":{"default":"dark","strict":false},"background":{"color":{"light":"#f1f0ea","dark":"#111110"}},"navbar":{"links":[{"href":"https://platform.hopscotchlabs.ai","label":"Dashboard"}]},"seo":{"indexing":"navigable"},"fonts":{"family":"Geist"},"icons":{"library":"tabler"},"styling":{"eyebrows":"section","codeblocks":{"theme":{"light":"vitesse-light","dark":"vesper"}},"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"unirouter","hasAudioNarration":false,"actualSubdomain":"unirouter","customDomains":["docs.hopscotchlabs.ai"],"gitSource":{"type":"github","owner":"uniblock-dev","repo":"unirouter-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adb83702d3c9c6f327a005f","collectionId":"39af8e51-e739-4223-bac0-6495e7203215","liveDeploymentHistoryId":"6adb83702d3c9c6f327a005f","schemaVersion":"v3"},"entitlements":{},"buildId":"6adb83702d3c9c6f327a005f","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Integrations","count":21},{"language":"default","tag":"Features","count":20},{"language":"default","tag":"Manage \u0026 monitor","count":18},{"language":"default","tag":"Coding agents","count":14},{"language":"default","tag":"API Reference","count":12},{"language":"default","tag":"Get started","count":9},{"language":"default","tag":"Overview","count":8},{"language":"default","tag":"Endpoints","count":7},{"language":"default","tag":"Request features","count":6},{"language":"default","tag":"SDKs and frameworks","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"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":true},"customCss":[{"filePath":"brand.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--uni-bg:#111110;--uni-pane:#161615;--uni-ink:#d2d2cc;--uni-mute:#9e9e98;--uni-dim:#80807a;--uni-faint:#61615b;--uni-bg-light:#f1f0ea;--uni-pane-light:#fafaf6;--uni-ink-light:#2b2b25;--uni-mute-light:#51514b;--uni-dim-light:#6c6c66;--uni-faint-light:#8a8a84;--uni-live:#00c5a9;--uni-live-light:#00786a;--uni-blue:#00afff;--uni-cyan:#00bfdf;--uni-indigo:#7c9cff;--uni-lime:#98b305;--uni-orange:#ef8600;--uni-pink:#f771a0;--uni-teal:#00c5a9;--uni-violet:#b688fe;--uni-ease-snap:cubic-bezier(0.22, 0.61, 0.36, 1)}[data-component-part=code-block],[data-component-part=code-block] *,code,kbd,pre,pre *,samp{font-family:\"Geist Mono\",ui-monospace,SFMono-Regular,\"SF Mono\",Menlo,Consolas,monospace}@supports (corner-shape:squircle){*{corner-shape:squircle}}::selection{background:rgb(126 200 212/.28);color:currentColor}:focus-visible:not(input):not(textarea):not(select){outline:1.5px solid color-mix(in srgb,currentColor 55%,transparent);outline-offset:3px}.overflow-x-auto,.overflow-y-auto,[data-component-part=code-block],body,html,pre{scrollbar-width:thin;scrollbar-color:color-mix(in srgb,currentColor 16%,transparent) transparent}[data-component-part=code-block]::-webkit-scrollbar,body::-webkit-scrollbar,html::-webkit-scrollbar,pre::-webkit-scrollbar{width:6px;height:6px}[data-component-part=code-block]::-webkit-scrollbar-thumb,body::-webkit-scrollbar-thumb,html::-webkit-scrollbar-thumb,pre::-webkit-scrollbar-thumb{background:color-mix(in srgb,currentColor 16%,transparent);border-radius:99px;border:2px solid transparent;background-clip:padding-box}[data-component-part=code-block]::-webkit-scrollbar-track,body::-webkit-scrollbar-track,html::-webkit-scrollbar-track,pre::-webkit-scrollbar-track{background:0 0}body{font-feature-settings:\"ss01\" on,\"cv11\" on;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;text-rendering:optimizeLegibility}@media (prefers-reduced-motion:reduce){*,::after,::before{animation-duration:.01ms!important;animation-iteration-count:1!important;transition-duration:.01ms!important;scroll-behavior:auto!important}}:root{--uni-ramp-bg:var(--uni-bg-light);--uni-ramp-pane:var(--uni-pane-light);--uni-ramp-ink:var(--uni-ink-light);--uni-ramp-mute:var(--uni-mute-light);--uni-ramp-dim:var(--uni-dim-light);--uni-ramp-faint:var(--uni-faint-light);--uni-ramp-line:color-mix(in srgb, var(--uni-ramp-ink) 10%, transparent);--uni-ramp-line-strong:color-mix(\n in srgb,\n var(--uni-ramp-ink) 16%,\n transparent\n );--uni-ramp-chip:color-mix(in srgb, var(--uni-ramp-ink) 6%, transparent);--uni-ramp-ink-hover:color-mix(\n in srgb,\n var(--uni-ramp-ink) 88%,\n var(--uni-ramp-bg)\n )}html.dark{--uni-ramp-bg:var(--uni-bg);--uni-ramp-pane:var(--uni-pane);--uni-ramp-ink:var(--uni-ink);--uni-ramp-mute:var(--uni-mute);--uni-ramp-dim:var(--uni-dim);--uni-ramp-faint:var(--uni-faint);--uni-ramp-line:rgb(255 255 255 / 0.08);--uni-ramp-line-strong:rgb(255 255 255 / 0.14)}.api-section,.callout,.card,details.accordion{background:var(--uni-ramp-pane);border:1px solid var(--uni-ramp-line);box-shadow:inset 0 1px 0 color-mix(in srgb,var(--uni-ramp-ink) 6%,transparent)}.card{border-radius:14px}.api-section,.callout,details.accordion{border-radius:12px}.card{transition:border-color 200ms var(--uni-ease-snap)}.card:hover{border-color:var(--uni-ramp-line-strong)}[data-component-part=card-icon]{color:var(--uni-ramp-mute);fill:var(--uni-ramp-mute)}[data-component-part=card-title]{color:var(--uni-ramp-ink);font-size:.875rem;font-weight:400;line-height:1.3;margin-top:.75rem}[data-component-part=card-content],[data-component-part=card-content] p,[data-component-part=card-content] span{color:var(--uni-ramp-mute);font-size:.8125rem;line-height:1.4}.accordion-group{background:var(--uni-ramp-pane);border:1px solid var(--uni-ramp-line);border-radius:12px;box-shadow:inset 0 1px 0 color-mix(in srgb,var(--uni-ramp-ink) 6%,transparent);overflow:hidden}.accordion-group>details.accordion{background:0 0;border:0;border-radius:0;box-shadow:none}.accordion-group>details.accordion+details.accordion{border-top:1px solid var(--uni-ramp-line)}[data-component-part=accordion-button]{padding:.75rem 1.25rem}[data-component-part=accordion-title]{color:var(--uni-ramp-ink);font-size:.875rem;font-weight:400;line-height:1.3}[data-component-part=accordion-caret-right]{color:var(--uni-ramp-faint);transition:transform 200ms var(--uni-ease-snap)}[data-component-part=accordion-content]{border-top:1px solid var(--uni-ramp-line);padding:1rem 1.25rem}.callout{padding:1rem 1.25rem}[data-component-part=callout-content],[data-component-part=callout-content] p{color:var(--uni-ramp-ink);font-size:.8125rem;line-height:1.5}[data-component-part=code-block-root]{border:1px solid var(--uni-ramp-line)}[data-component-part=code-block-header-filename],[data-component-part=code-block-header],[data-component-part=code-group-tab-bar]{color:var(--uni-ramp-dim);font-size:.75rem;line-height:1.4}[data-component-part=code-group-tab-bar]{border-bottom:1px solid var(--uni-ramp-line)}[data-component-part=step-line]{background:var(--uni-ramp-line)}[data-component-part=step-number]>*{background:var(--uni-ramp-chip);color:var(--uni-ramp-ink);font-size:.6875rem;font-weight:400}[data-component-part=step-title]{color:var(--uni-ramp-ink);font-size:.875rem;font-weight:400;line-height:1.3}.api-section{padding:1.25rem}.api-section+.api-section{margin-top:.75rem}.api-section-heading-title{color:var(--uni-ramp-ink);font-size:.875rem;font-weight:400;line-height:1.3}.api-section-heading-subtitle{color:var(--uni-ramp-dim);font-size:.75rem;line-height:1.4}.param-head{border-bottom:1px solid var(--uni-ramp-line);padding-bottom:.5rem}.array-param-field:last-child>.param-head,.object-param-field:last-child>.param-head,.primitive-param-field:last-child>.param-head{border-bottom:0}[data-component-part=field-name]{color:var(--uni-ramp-ink);font-weight:500}[data-component-part=field-name]:hover{color:var(--uni-ramp-ink);text-decoration:underline;text-decoration-color:var(--uni-ramp-line-strong);text-underline-offset:3px}[data-component-part=field-meta]{color:var(--uni-ramp-dim);font-size:.75rem}[data-component-part=field-info-pill],[data-component-part=field-required-pill]{background:var(--uni-ramp-chip);border-radius:9999px;color:var(--uni-ramp-ink);font-size:.6875rem;font-weight:400;padding:.0625rem .5rem}[data-component-part=field-info-pill]{color:var(--uni-ramp-dim)}.method-nav-pill,.method-pill{border-radius:0;font-size:.625rem;font-weight:400;letter-spacing:.06em;padding:.125rem .375rem;text-transform:uppercase}.tryit-button{background:var(--uni-ramp-ink);border-radius:10px;color:var(--uni-ramp-bg);font-weight:400;transition:background 200ms var(--uni-ease-snap)}.tryit-button:hover{background:var(--uni-ramp-ink-hover);filter:none;opacity:1}.tryit-button svg{fill:var(--uni-ramp-bg);color:var(--uni-ramp-bg)}[data-component-part=expandable-button]{color:var(--uni-ramp-dim);font-size:.75rem}[data-component-part=expandable-button]:hover{color:var(--uni-ramp-ink)}[data-component-part=expandable-content]{border-left:1px solid var(--uni-ramp-line);padding-left:1rem}[data-provider]{--uni-accent:var(--uni-ramp-mute)}[data-provider]:not(.card){align-items:center;display:inline-flex;gap:.375rem}[data-provider]:not(.card)::before{background:var(--uni-accent);content:\"\";display:inline-block;flex:none;height:6px;width:6px}[data-provider][data-mark=tag]{background:var(--uni-accent);border-radius:0;color:#111110;font-size:.625rem;letter-spacing:.06em;padding:.125rem .25rem;text-transform:uppercase}[data-provider][data-mark=tag]::before{content:none}[data-provider=alibaba],[data-provider=anthropic],[data-provider=mistral],[data-provider=qwen]{--uni-accent:var(--uni-orange)}[data-provider=openai]{--uni-accent:var(--uni-blue)}[data-provider=fireworks],[data-provider=moonshot]{--uni-accent:var(--uni-cyan)}[data-provider=deepseek]{--uni-accent:var(--uni-teal)}[data-provider=deepinfra]{--uni-accent:var(--uni-indigo)}[data-provider=google],[data-provider=z-ai],[data-provider=zai],[data-provider=zhipu]{--uni-accent:var(--uni-violet)}[data-provider=groq]{--uni-accent:var(--uni-pink)}[data-provider=meta],[data-provider=together]{--uni-accent:var(--uni-lime)}.card[data-provider] [data-component-part=card-icon]{color:var(--uni-accent);fill:var(--uni-accent)}"}],"page":{"pagePath":"api-reference/models/retrieve-a-model","slug":"/api-reference/models/retrieve-a-model","pageMetadata":{"title":"Retrieve a model","description":"Everything the list carries for one model, plus the fields served only here: the model's own description, the request parameters it accepts, and its deprecation and sunset dates where it has them.\n\nA model id contains slashes and the whole of it is the identifier. Percent-encode it once, or send it unencoded; a double-encoded slash names no model and answers 404.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.public.json get /v1/models/{id}","href":"/api-reference/models/retrieve-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 p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Everything the list carries for one model, plus the fields served only here: the model’s own description, the request parameters it accepts, and its deprecation and sunset dates where it has them.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"A model id contains slashes and the whole of it is the identifier. Percent-encode it once, or send it unencoded; a double-encoded slash names no model and answers 404.\"\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":{"codeStyling":{"theme":{"light":"vitesse-light","dark":"vesper"}},"config":{},"pageMetadata":{"title":"Retrieve a model","description":"Everything the list carries for one model, plus the fields served only here: the model's own description, the request parameters it accepts, and its deprecation and sunset dates where it has them.\n\nA model id contains slashes and the whole of it is the identifier. Percent-encode it once, or send it unencoded; a double-encoded slash names no model and answers 404.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.public.json get /v1/models/{id}","href":"/api-reference/models/retrieve-a-model","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"servers":["c0bffb5b-9fbd-4efa-b888-09d9af113daf"],"tags":["Models"],"summary":"Retrieve a model","description":"Everything the list carries for one model, plus the fields served only here: the model's own description, the request parameters it accepts, and its deprecation and sunset dates where it has them.\n\nA model id contains slashes and the whole of it is the identifier. Percent-encode it once, or send it unencoded; a double-encoded slash names no model and answers 404.","parameters":["cb08bfc1-d919-487d-8961-47dc670e32d8"],"responses":{"200":"2ada4b4d-1786-4091-913b-31ba63b50391","401":"1df64c4c-87be-424e-98cd-5caf686b3a05","403":"82a3939a-ee2c-44fc-b75a-3a164713d971","404":"c557c969-8bd8-44ff-ada6-5c73ec9b5bf4","405":"068fda42-2238-4857-9b5f-4ba683045fe9","429":"39e0c98d-d583-4c7d-a1e7-a52d905a0134","500":"38060838-2582-44d2-920f-3d9606ff5e84","503":"fab5fcba-6465-49fc-b0a9-9fad96f279d4"},"security":["7e5e2c00-986c-4997-aad8-e72c5e7eeea3"],"operationId":"retrieveModel","method":"get","type":"path","path":"/v1/models/{id}","baseUrlOptions":["https://api.hopscotchlabs.ai"],"title":"Retrieve a model","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cb08bfc1-d919-487d-8961-47dc670e32d8":{"name":"id","in":"path","required":true,"description":"The model id, exactly as the list gives it.","schema":{"type":"string","isRequired":true,"description":"The model id, exactly as the list gives it.","uniqueKey":"","typeLabel":"string"},"example":"openai/gpt-4o-mini"}},"responses":{"2ada4b4d-1786-4091-913b-31ba63b50391":{"description":"The model.","content":{"application/json":{"schema":{"type":"object","description":"One model, in the same envelope the list uses, with the detail-only fields under `uniblock`.","additionalProperties":true,"properties":{"id":{"type":"string","example":"openai/gpt-4o-mini","uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","example":"model","uniqueKey":"object","typeLabel":"string"},"created":{"type":"integer","uniqueKey":"created","typeLabel":"integer"},"owned_by":{"type":"string","uniqueKey":"owned_by","typeLabel":"string"},"shutdown_date":{"type":"integer","description":"Absent when the model has no announced end.","uniqueKey":"shutdown_date","typeLabel":"integer"},"uniblock":{"type":"object","description":"Everything the list carries for a model, plus the five fields served only when one model is asked for by name.","required":["description","parameters","deprecated_at","sunset_at","replacement_model_id","model_id","display_name","author","input_rate_thousandths","endpoint_families","provider_display_names","capabilities"],"properties":{"model_id":{"type":"string","description":"The same value as `id`, repeated inside the extension so a client reading only this block still has it.","isRequired":true,"uniqueKey":"uniblock.model_id","typeLabel":"string"},"display_name":{"type":"string","isRequired":true,"uniqueKey":"uniblock.display_name","typeLabel":"string"},"author":{"type":"string","description":"Who made the model, which is not who serves it.","isRequired":true,"uniqueKey":"uniblock.author","typeLabel":"string"},"input_rate_thousandths":{"type":"integer","description":"The provider's own list price for prompt tokens, in thousandths of the currency unit per million tokens. Nothing this platform charges on top is folded in: the fee is taken when credit is bought, and a request then costs the provider's price.","isRequired":true,"uniqueKey":"uniblock.input_rate_thousandths","typeLabel":"integer"},"endpoint_families":{"type":"array","items":{"type":"string","uniqueKey":"uniblock.endpoint_families.items.[INDEX]","typeLabel":"string"},"description":"The request families this model answers.","isRequired":true,"uniqueKey":"uniblock.endpoint_families","typeLabel":"string[]"},"provider_display_names":{"type":"array","items":{"type":"string","uniqueKey":"uniblock.provider_display_names.items.[INDEX]","typeLabel":"string"},"description":"Who can serve it. Which one answered a given request is on the response headers, not here.","isRequired":true,"uniqueKey":"uniblock.provider_display_names","typeLabel":"string[]"},"capabilities":{"type":"object","description":"What the catalog records this model can do. Each answer is one of three words, and `unknown` is not `no`: it means nobody has established the answer.","additionalProperties":false,"required":["audio","json_mode","streaming","tools","vision"],"properties":{"audio":{"type":"string","enum":["no","unknown","yes"],"isRequired":true,"uniqueKey":"uniblock.capabilities.audio","typeLabel":"enum\u003cstring>"},"json_mode":{"type":"string","enum":["no","unknown","yes"],"isRequired":true,"uniqueKey":"uniblock.capabilities.json_mode","typeLabel":"enum\u003cstring>"},"streaming":{"type":"string","enum":["no","unknown","yes"],"isRequired":true,"uniqueKey":"uniblock.capabilities.streaming","typeLabel":"enum\u003cstring>"},"tools":{"type":"string","enum":["no","unknown","yes"],"isRequired":true,"uniqueKey":"uniblock.capabilities.tools","typeLabel":"enum\u003cstring>"},"vision":{"type":"string","enum":["no","unknown","yes"],"isRequired":true,"uniqueKey":"uniblock.capabilities.vision","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"uniblock.capabilities","typeLabel":"object"},"description":{"oneOf":[{"type":"string","description":"Detail only. The list is scanned and the detail is read, so the prose a model carries is served where somebody asked for that one model.","isRequired":true,"uniqueKey":"uniblock.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Detail only. The list is scanned and the detail is read, so the prose a model carries is served where somebody asked for that one model.","isRequired":true,"uniqueKey":"uniblock.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"uniblock.description","typeLabel":"string | null"},"parameters":{"type":"array","items":{"type":"object","description":"One request parameter this model accepts. The three bounds are in thousandths of the parameter's own unit, so a temperature ceiling of 2 arrives as 2000 and a default of 0.7 as 700. Integers, because a bound that drifted in its last decimal place would be a contract about nothing.","additionalProperties":false,"required":["name","type","min_milli","max_milli","default_milli","enum_values","sent_by_default","note"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["boolean","enum","integer","number","string"],"description":"The control shape a client should render.","isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"min_milli":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].min_milli.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].min_milli.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].min_milli","typeLabel":"integer | null"},"max_milli":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].max_milli.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].max_milli.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].max_milli","typeLabel":"integer | null"},"default_milli":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].default_milli.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].default_milli.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].default_milli","typeLabel":"integer | null"},"enum_values":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"uniblock.parameters.items.[INDEX].enum_values.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].enum_values.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].enum_values.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].enum_values","typeLabel":"string[] | null"},"sent_by_default":{"type":"boolean","description":"Whether a client sends this parameter unless it is told otherwise.","isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].sent_by_default","typeLabel":"boolean"},"note":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].note.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].note.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"uniblock.parameters.items.[INDEX].note","typeLabel":"string | null"}},"uniqueKey":"uniblock.parameters.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"uniblock.parameters","typeLabel":"object[]"},"deprecated_at":{"oneOf":[{"type":"integer","description":"Unix seconds.","isRequired":true,"uniqueKey":"uniblock.deprecated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Unix seconds.","isRequired":true,"uniqueKey":"uniblock.deprecated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"uniblock.deprecated_at","typeLabel":"integer | null"},"sunset_at":{"oneOf":[{"type":"integer","description":"Unix seconds.","isRequired":true,"uniqueKey":"uniblock.sunset_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Unix seconds.","isRequired":true,"uniqueKey":"uniblock.sunset_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"uniblock.sunset_at","typeLabel":"integer | null"},"replacement_model_id":{"oneOf":[{"type":"string","description":"What to move to, where one is named.","isRequired":true,"uniqueKey":"uniblock.replacement_model_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"What to move to, where one is named.","isRequired":true,"uniqueKey":"uniblock.replacement_model_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"uniblock.replacement_model_id","typeLabel":"string | null"},"context_window_tokens":{"oneOf":[{"type":"integer","uniqueKey":"uniblock.context_window_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"uniblock.context_window_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"uniblock.context_window_tokens","typeLabel":"integer | null"},"max_output_tokens":{"oneOf":[{"type":"integer","uniqueKey":"uniblock.max_output_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"uniblock.max_output_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"uniblock.max_output_tokens","typeLabel":"integer | null"},"output_rate_thousandths":{"type":"integer","description":"The same unit, for completion tokens. Absent when the model publishes no separate output rate.","uniqueKey":"uniblock.output_rate_thousandths","typeLabel":"integer"},"currency_code":{"oneOf":[{"type":"string","description":"ISO 4217, or null where nobody recorded one.","uniqueKey":"uniblock.currency_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 4217, or null where nobody recorded one.","uniqueKey":"uniblock.currency_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"uniblock.currency_code","typeLabel":"string | null"}},"additionalProperties":true,"uniqueKey":"uniblock","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"openai/gpt-4o-mini","object":"model","created":1756080000,"owned_by":"openai","uniblock":{"model_id":"openai/gpt-4o-mini","display_name":"GPT-4o mini","author":"openai","author_slug":"openai","author_source":"recorded","context_window_tokens":128000,"max_output_tokens":16384,"input_rate_thousandths":150,"output_rate_thousandths":600,"currency_code":"USD","endpoint_families":["chat_completions"],"provider_display_names":["OpenAI"],"provider_families":["openai"],"capabilities":{"streaming":"yes","tools":"yes","json_mode":"yes","vision":"yes","audio":"no"},"parameters":[{"name":"temperature","type":"number","min_milli":0,"max_milli":2000,"default_milli":1000,"enum_values":null,"sent_by_default":false,"note":"Higher values make the reply less predictable."}],"deprecated_at":null,"sunset_at":null,"moving_alias":null,"replacement_model_id":null,"description":"A small, fast model for everyday chat and extraction work."}},"examples":{"Example":{"title":"Example","value":{"id":"openai/gpt-4o-mini","object":"model","created":1756080000,"owned_by":"openai","uniblock":{"model_id":"openai/gpt-4o-mini","display_name":"GPT-4o mini","author":"openai","author_slug":"openai","author_source":"recorded","context_window_tokens":128000,"max_output_tokens":16384,"input_rate_thousandths":150,"output_rate_thousandths":600,"currency_code":"USD","endpoint_families":["chat_completions"],"provider_display_names":["OpenAI"],"provider_families":["openai"],"capabilities":{"streaming":"yes","tools":"yes","json_mode":"yes","vision":"yes","audio":"no"},"parameters":[{"name":"temperature","type":"number","min_milli":0,"max_milli":2000,"default_milli":1000,"enum_values":null,"sent_by_default":false,"note":"Higher values make the reply less predictable."}],"deprecated_at":null,"sunset_at":null,"moving_alias":null,"replacement_model_id":null,"description":"A small, fast model for everyday chat and extraction work."}}}},"exampleType":"examples"}},"headers":{"x-hopscotch-request-id":{"description":"Our id for this request. Quote it when you contact support. Present on every response, errors included.","schema":{"type":"string"}}},"exampleType":"examples"},"1df64c4c-87be-424e-98cd-5caf686b3a05":{"description":"No key, a scheme other than Bearer, a key of the wrong shape, a key we reject, or a key past its own expiry date, which carries code `key_expired` and names the date it expired on.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope. One top-level `error` key, always, at every status.","required":["error"],"additionalProperties":false,"properties":{"error":{"type":"object","required":["message","type","param","code"],"additionalProperties":false,"properties":{"message":{"type":"string","description":"Prose for a person. It may be reworded, so do not branch on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The category an SDK branches on. A closed set.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error","insufficient_quota","server_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string | null"},"request_id":{"type":"string","description":"Our id for this request, the same value as the x-hopscotch-request-id header. Quote it when you contact support.","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Incorrect API key provided.","type":"authentication_error","param":null,"code":"invalid_api_key","request_id":"REQUEST_ID"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Incorrect API key provided.","type":"authentication_error","param":null,"code":"invalid_api_key","request_id":"REQUEST_ID"}}}},"exampleType":"examples"}},"headers":{"x-hopscotch-request-id":{"description":"Our id for this request. Quote it when you contact support. Present on every response, errors included.","schema":{"type":"string"}}},"exampleType":"examples"},"82a3939a-ee2c-44fc-b75a-3a164713d971":{"description":"The key belongs to an account staff have suspended, and code is `account_suspended`. The key itself is not revoked: it authenticates again when the account is reinstated. Retrying will not change the answer; contact support.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope. One top-level `error` key, always, at every status.","required":["error"],"additionalProperties":false,"properties":{"error":{"type":"object","required":["message","type","param","code"],"additionalProperties":false,"properties":{"message":{"type":"string","description":"Prose for a person. It may be reworded, so do not branch on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The category an SDK branches on. A closed set.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error","insufficient_quota","server_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string | null"},"request_id":{"type":"string","description":"Our id for this request, the same value as the x-hopscotch-request-id header. Quote it when you contact support.","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"This account is suspended, so it cannot send requests. Contact support. Request id REQUEST_ID.","type":"permission_error","param":null,"code":"account_suspended","request_id":"REQUEST_ID"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"This account is suspended, so it cannot send requests. Contact support. Request id REQUEST_ID.","type":"permission_error","param":null,"code":"account_suspended","request_id":"REQUEST_ID"}}}},"exampleType":"examples"}},"headers":{"x-hopscotch-request-id":{"description":"Our id for this request. Quote it when you contact support. Present on every response, errors included.","schema":{"type":"string"}}},"exampleType":"examples"},"c557c969-8bd8-44ff-ada6-5c73ec9b5bf4":{"description":"No model of that id is in the live catalog. A model we hold but do not publish answers the same way as one we have never heard of, on purpose.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope. One top-level `error` key, always, at every status.","required":["error"],"additionalProperties":false,"properties":{"error":{"type":"object","required":["message","type","param","code"],"additionalProperties":false,"properties":{"message":{"type":"string","description":"Prose for a person. It may be reworded, so do not branch on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The category an SDK branches on. A closed set.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error","insufficient_quota","server_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string | null"},"request_id":{"type":"string","description":"Our id for this request, the same value as the x-hopscotch-request-id header. Quote it when you contact support.","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"The model \"openai/gpt-4o-mini\" was not found in the live catalog.","type":"not_found_error","param":"model","code":"model_not_found","request_id":"REQUEST_ID"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"The model \"openai/gpt-4o-mini\" was not found in the live catalog.","type":"not_found_error","param":"model","code":"model_not_found","request_id":"REQUEST_ID"}}}},"exampleType":"examples"}},"headers":{"x-hopscotch-request-id":{"description":"Our id for this request. Quote it when you contact support. Present on every response, errors included.","schema":{"type":"string"}}},"exampleType":"examples"},"068fda42-2238-4857-9b5f-4ba683045fe9":{"description":"A method other than GET on a path that exists. The route boundary answers this before any key is looked at, so it costs nothing and reveals nothing.","headers":{"Allow":{"schema":{"type":"string","enum":["GET"]},"description":"The methods this path accepts.","example":"GET"},"x-hopscotch-request-id":{"description":"Our id for this request. Quote it when you contact support. Present on every response, errors included.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"The error envelope. One top-level `error` key, always, at every status.","required":["error"],"additionalProperties":false,"properties":{"error":{"type":"object","required":["message","type","param","code"],"additionalProperties":false,"properties":{"message":{"type":"string","description":"Prose for a person. It may be reworded, so do not branch on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The category an SDK branches on. A closed set.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error","insufficient_quota","server_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string | null"},"request_id":{"type":"string","description":"Our id for this request, the same value as the x-hopscotch-request-id header. Quote it when you contact support.","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"POST is not supported for /v1/models/openai/gpt-4o-mini in this release.","type":"invalid_request_error","param":null,"code":"method_not_allowed","request_id":"REQUEST_ID"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"POST is not supported for /v1/models/openai/gpt-4o-mini in this release.","type":"invalid_request_error","param":null,"code":"method_not_allowed","request_id":"REQUEST_ID"}}}},"exampleType":"examples"}},"exampleType":"examples"},"39e0c98d-d583-4c7d-a1e7-a52d905a0134":{"description":"This key's own request rate limit. Every route on this API is subject to it.","headers":{"Retry-After":{"schema":{"type":"integer","minimum":1},"example":17,"description":"Seconds to wait."},"x-hopscotch-request-id":{"description":"Our id for this request. Quote it when you contact support. Present on every response, errors included.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"The error envelope. One top-level `error` key, always, at every status.","required":["error"],"additionalProperties":false,"properties":{"error":{"type":"object","required":["message","type","param","code"],"additionalProperties":false,"properties":{"message":{"type":"string","description":"Prose for a person. It may be reworded, so do not branch on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The category an SDK branches on. A closed set.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error","insufficient_quota","server_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string | null"},"request_id":{"type":"string","description":"Our id for this request, the same value as the x-hopscotch-request-id header. Quote it when you contact support.","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Rate limit reached for this key. Try again in 12 seconds. Request id REQUEST_ID.","type":"rate_limit_error","param":null,"code":"rate_limit_exceeded","request_id":"REQUEST_ID"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Rate limit reached for this key. Try again in 12 seconds. Request id REQUEST_ID.","type":"rate_limit_error","param":null,"code":"rate_limit_exceeded","request_id":"REQUEST_ID"}}}},"exampleType":"examples"}},"exampleType":"examples"},"38060838-2582-44d2-920f-3d9606ff5e84":{"description":"A fault on our side. The request id is the one thing worth keeping.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope. One top-level `error` key, always, at every status.","required":["error"],"additionalProperties":false,"properties":{"error":{"type":"object","required":["message","type","param","code"],"additionalProperties":false,"properties":{"message":{"type":"string","description":"Prose for a person. It may be reworded, so do not branch on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The category an SDK branches on. A closed set.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error","insufficient_quota","server_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string | null"},"request_id":{"type":"string","description":"Our id for this request, the same value as the x-hopscotch-request-id header. Quote it when you contact support.","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"The server had an error while processing your request. Sorry about that! Quote the request id if you contact support.","type":"api_error","param":null,"code":null,"request_id":"REQUEST_ID"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"The server had an error while processing your request. Sorry about that! Quote the request id if you contact support.","type":"api_error","param":null,"code":null,"request_id":"REQUEST_ID"}}}},"exampleType":"examples"}},"headers":{"x-hopscotch-request-id":{"description":"Our id for this request. Quote it when you contact support. Present on every response, errors included.","schema":{"type":"string"}}},"exampleType":"examples"},"fab5fcba-6465-49fc-b0a9-9fad96f279d4":{"description":"The catalog could not be served. Nothing is wrong with the request; retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error envelope. One top-level `error` key, always, at every status.","required":["error"],"additionalProperties":false,"properties":{"error":{"type":"object","required":["message","type","param","code"],"additionalProperties":false,"properties":{"message":{"type":"string","description":"Prose for a person. It may be reworded, so do not branch on it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The category an SDK branches on. A closed set.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error","insufficient_quota","server_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request field at fault, or null. Present and null rather than absent.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stable machine-readable reason. Branch on this.","isRequired":true,"uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string | null"},"request_id":{"type":"string","description":"Our id for this request, the same value as the x-hopscotch-request-id header. Quote it when you contact support.","uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"No provider is configured, so there is nothing to serve this request.","type":"api_error","param":null,"code":"no_provider_configured","request_id":"REQUEST_ID"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"No provider is configured, so there is nothing to serve this request.","type":"api_error","param":null,"code":"no_provider_configured","request_id":"REQUEST_ID"}}}},"exampleType":"examples"}},"headers":{"x-hopscotch-request-id":{"description":"Our id for this request. Quote it when you contact support. Present on every response, errors included.","schema":{"type":"string"}}},"exampleType":"examples"}},"security":{"7e5e2c00-986c-4997-aad8-e72c5e7eeea3":{"customerApiKey":{"type":"http","scheme":"bearer","description":"A workspace API key in an `Authorization: Bearer` header. A missing header, a scheme other than Bearer, a key of the wrong shape, and a key we reject are all 401.","scopes":[],"schemeName":"customerApiKey"}}},"servers":{"c0bffb5b-9fbd-4efa-b888-09d9af113daf":{"url":"https://api.hopscotchlabs.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A workspace API key in an `Authorization: Bearer` header. A missing header, a scheme other than Bearer, a key of the wrong shape, and a key we reject are all 401.","scopes":[],"schemeName":"customerApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A workspace API key in an `Authorization: Bearer` header. A missing header, a scheme other than Bearer, a key of the wrong shape, and a key we reject are all 401.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"customerApiKey","name":"Authorization"}],"title":"customerApiKey"}]},"originalFileLocation":"api-reference/openapi.public.json"},"subdomain":"unirouter","siteName":"Hopscotch","title":"Retrieve a model - Hopscotch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T15:56:12.658Z","originalFileLocation":"api-reference/models/retrieve-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=\"dark\"}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=\"Everything the list carries for one model, plus the fields served only here: the model\u0026#x27;s own description, the request parameters it accepts, and its deprecation and sunset dates where it has them. A model id contains slashes and the whole of it is the identifier. Percent-encode it once, or send it unencoded; a double-encoded slash names no model and answers 404.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hopscotch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/unirouter/51ojQE1LhN9oLy-j/_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/unirouter/51ojQE1LhN9oLy-j/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/unirouter/51ojQE1LhN9oLy-j/_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/unirouter/51ojQE1LhN9oLy-j/_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/unirouter/51ojQE1LhN9oLy-j/_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/unirouter/51ojQE1LhN9oLy-j/_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/unirouter/51ojQE1LhN9oLy-j/_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/unirouter/51ojQE1LhN9oLy-j/_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/unirouter/51ojQE1LhN9oLy-j/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a model - Hopscotch\">\u003cmeta data-mint-head property=\"og:description\" content=\"Everything the list carries for one model, plus the fields served only here: the model\u0026#x27;s own description, the request parameters it accepts, and its deprecation and sunset dates where it has them. A model id contains slashes and the whole of it is the identifier. Percent-encode it once, or send it unencoded; a double-encoded slash names no model and answers 404.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hopscotch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hopscotchlabs.ai/api-reference/models/retrieve-a-model\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://unirouter.mintlify.app/_mintlify/api/og/v2?division=Models\u0026amp;title=Retrieve+a+model\u0026amp;description=Everything+the+list+carries+for+one+model%2C+plus+the+fields+served+only+here%3A+the+model%27s+own+description%2C+the+request+parameters+it+accepts%2C+and+its+deprecation\u0026amp;theme=6715395fa0e7fb019cdde93e\u0026amp;signature=5e4298a78cda8c8bc90df3b14046e0ca0f84c3ea9f906cdb911a3c8aab606b39\">\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=\"Retrieve a model - Hopscotch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Everything the list carries for one model, plus the fields served only here: the model\u0026#x27;s own description, the request parameters it accepts, and its deprecation and sunset dates where it has them. A model id contains slashes and the whole of it is the identifier. Percent-encode it once, or send it unencoded; a double-encoded slash names no model and answers 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://unirouter.mintlify.app/_mintlify/api/og/v2?division=Models\u0026amp;title=Retrieve+a+model\u0026amp;description=Everything+the+list+carries+for+one+model%2C+plus+the+fields+served+only+here%3A+the+model%27s+own+description%2C+the+request+parameters+it+accepts%2C+and+its+deprecation\u0026amp;theme=6715395fa0e7fb019cdde93e\u0026amp;signature=5e4298a78cda8c8bc90df3b14046e0ca0f84c3ea9f906cdb911a3c8aab606b39\">\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/unirouter/51ojQE1LhN9oLy-j/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hopscotch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00786a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hopscotchlabs.ai/api-reference/models/retrieve-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/retrieve-a-model.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hopscotchlabs.ai/#organization\",\"name\":\"Hopscotch\",\"url\":\"https://docs.hopscotchlabs.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/unirouter/e-jU4qy0Y8gPhRZJ/logo/light.svg?fit=max\u0026auto=format\u0026n=e-jU4qy0Y8gPhRZJ\u0026q=85\u0026s=eb9901b22939c791c90369af09611ebe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hopscotchlabs.ai#website\",\"name\":\"Hopscotch\",\"url\":\"https://docs.hopscotchlabs.ai\",\"publisher\":{\"@id\":\"https://docs.hopscotchlabs.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hopscotchlabs.ai/api-reference/models/retrieve-a-model#webpage\",\"url\":\"https://docs.hopscotchlabs.ai/api-reference/models/retrieve-a-model\",\"name\":\"Retrieve a model\",\"description\":\"Everything the list carries for one model, plus the fields served only here: the model's own description, the request parameters it accepts, and its deprecation and sunset dates where it has them. A model id contains slashes and the whole of it is the identifier. Percent-encode it once, or send it unencoded; a double-encoded slash names no model and answers 404.\",\"dateModified\":\"2026-10-23T15:56:12.658Z\",\"isPartOf\":{\"@id\":\"https://docs.hopscotchlabs.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hopscotchlabs.ai/api-reference/models/retrieve-a-model#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hopscotchlabs.ai/api-reference/models/retrieve-a-model#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.hopscotchlabs.ai/api-reference/chat/create-a-chat-completion\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Models\",\"item\":\"https://docs.hopscotchlabs.ai/api-reference/models/list-models\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a model\",\"item\":\"https://docs.hopscotchlabs.ai/api-reference/models/retrieve-a-model\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hopscotchlabs.ai/api-reference/models/retrieve-a-model#apireference\",\"headline\":\"Retrieve a model\",\"name\":\"Retrieve a model\",\"description\":\"Everything the list carries for one model, plus the fields served only here: the model's own description, the request parameters it accepts, and its deprecation and sunset dates where it has them. A model id contains slashes and the whole of it is the identifier. Percent-encode it once, or send it unencoded; a double-encoded slash names no model and answers 404.\",\"url\":\"https://docs.hopscotchlabs.ai/api-reference/models/retrieve-a-model\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hopscotchlabs.ai/api-reference/models/retrieve-a-model#webpage\"},\"dateModified\":\"2026-10-23T15:56:12.658Z\",\"publisher\":{\"@id\":\"https://docs.hopscotchlabs.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hopscotchlabs.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hopscotch\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hopscotch","nav":{"global":null,"tabs":[{"tab":"Get started","icon":"player-play","pages":[{"title":"Get started","href":""}]},{"tab":"Features","icon":"stack-2","pages":[{"title":"Features","href":"/features/overview"}]},{"tab":"Manage \u0026 monitor","icon":"gauge","pages":[{"title":"Manage \u0026 monitor","href":"/manage/overview"}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Request parameters","href":"/api-reference/parameters"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Headers","href":"/api-reference/headers"}]},{"group":"Endpoints","pages":[{"group":"Chat","pages":[{"title":"Create a chat completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.public.json post /v1/chat/completions","href":"/api-reference/chat/create-a-chat-completion"}]},{"group":"Completions","pages":[{"title":"Create a text completion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.public.json post /v1/completions","href":"/api-reference/completions/create-a-text-completion"}]},{"group":"Models","pages":[{"title":"List models","description":"List the models you can call. The `id` of each entry is what you send as `model`.\n\nEach entry is the OpenAI model object with a `uniblock` block beside it, carrying what OpenAI's own object has no field for: who serves the model, what it can do, its context window, and the provider's list price.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.public.json get /v1/models","href":"/api-reference/models/list-models"},{"title":"Retrieve a model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.public.json get /v1/models/{id}","href":"/api-reference/models/retrieve-a-model"}]},{"group":"Responses","pages":[{"title":"Create a model response","description":"Send a request in the OpenAI Responses format. Set `stream: true` for server-sent events.\n\nThis is the same door as chat completions: the same key, the same catalog, the same hold against your balance and the same usage row, filed under its own endpoint family so a charge is recognisable. The body is forwarded as you sent it, with one exception documented on `store` below.\n\nCredit is held when the request is admitted and settled against the provider's own token counts when it finishes. You are charged the provider's rate at face value. Nothing is added per request.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.public.json post /v1/responses","href":"/api-reference/responses/create-a-model-response"}]},{"group":"Usage","pages":[{"title":"Retrieve one request's usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.public.json get /v1/usage/{id}","href":"/api-reference/usage/retrieve-one-requests-usage"}]},{"group":"Messages","pages":[{"title":"Create a message (Anthropic Messages API)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.public.json post /v1/messages","href":"/api-reference/messages/create-a-message-anthropic-messages-api"}]}]}]}]},"title":"Retrieve a model - Hopscotch","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"]}