ID of the model, as listed by GET /models/aligned or GET /models/base
Response
Returns one aligned model: its model_id, model_name, base model, derived deployment status and timestamps.
One aligned model's full record: identity, lineage, live deployment
status and everything on its status and list rows.
progress and eta_seconds mirror the deployment-status shape but are not
wired up yet, so they are always null here too. created_at/updated_at are
the model's own persisted timestamps, not the deployment status endpoint's
per-request ones (that endpoint's timestamps mark when a status check
ran, not real historical state, so they are not merged in here).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nugen API Reference Docs","colors":{"primary":"#005b96","light":"#6497b1","dark":"#005b96"},"logo":{"light":"https://mintcdn.com/courteasy/YYugGl8ZAoQlnBYp/logo/light.svg?fit=max\u0026auto=format\u0026n=YYugGl8ZAoQlnBYp\u0026q=85\u0026s=f5f462b08161252f94dca4827e8055a0","dark":"https://mintcdn.com/courteasy/YYugGl8ZAoQlnBYp/logo/dark.svg?fit=max\u0026auto=format\u0026n=YYugGl8ZAoQlnBYp\u0026q=85\u0026s=c1f31d3028b6ad46f4c22208d402733e"},"favicon":"https://mintcdn.com/courteasy/YYugGl8ZAoQlnBYp/favicon.png?fit=max\u0026auto=format\u0026n=YYugGl8ZAoQlnBYp\u0026q=85\u0026s=74a9985970701685cc9f798a5bed86fe","api":{"openapi":"https://api.nugen.in/openapi-public.json","mdx":{"auth":{"method":"bearer"},"server":"https://api.nugen.in/"}},"navbar":{"links":[{"href":"https://github.com/nugen-in/nugen-cookbook","label":"Cookbook"}],"primary":{"type":"button","label":"Get API Key","href":"https://nugen.in/signup"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/nugen-in"}},"contextual":{"options":["copy","vscode","claude","chatgpt","perplexity","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Status","icon":"bolt-lightning","href":"https://status.nugen.in"},{"anchor":"Nugen Intelligence","icon":"earth-asia","href":"https://nugen.in"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"courteasy","hasAudioNarration":false,"actualSubdomain":"courteasy","customDomains":["docs.nugen.in"],"gitSource":{"type":"github","owner":"nugen-in","repo":"nugen-docs-test","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae488e3c69c99d3b7d10d90","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":43},{"language":"default","tag":"Models","count":10},{"language":"default","tag":"Alignment Projects","count":7},{"language":"default","tag":"Benchmarks","count":7},{"language":"default","tag":"Evaluations","count":6},{"language":"default","tag":"Documents","count":5},{"language":"default","tag":"Inference","count":5},{"language":"default","tag":"BYOC","count":2},{"language":"default","tag":"Health","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/models/get-model","slug":"/api-reference/models/get-model","pageMetadata":{"title":"Get Model","description":"Get one aligned model by ID.\n\n**Returns:**\n\n- `model_id`, `model_name`, `base_model_id`, `base_model_name`, `alignment_id`\n- `deployment_status` (`UNDEPLOYED`, `DEPLOYING`, `DEPLOYED`, `UNDEPLOYING`), derived from the live deployment\n- `error`: why the last deploy or undeploy failed, null when it succeeded\n- `progress`, `eta_seconds`: not wired up yet, always null\n- `performance_metrics`, `evaluation_data`: from the model's latest evaluation, if any\n- `usage_count`, `downloadable`: not wired up yet, always 0 and false\n- `inference_capture_enabled`\n- `created_at`, `updated_at`","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/models/{model_id}","href":"/api-reference/models/get-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 li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Get one aligned model by ID.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Returns:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"model_id\"\n }), \", \", _jsx(_components.code, {\n children: \"model_name\"\n }), \", \", _jsx(_components.code, {\n children: \"base_model_id\"\n }), \", \", _jsx(_components.code, {\n children: \"base_model_name\"\n }), \", \", _jsx(_components.code, {\n children: \"alignment_id\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"deployment_status\"\n }), \" (\", _jsx(_components.code, {\n children: \"UNDEPLOYED\"\n }), \", \", _jsx(_components.code, {\n children: \"DEPLOYING\"\n }), \", \", _jsx(_components.code, {\n children: \"DEPLOYED\"\n }), \", \", _jsx(_components.code, {\n children: \"UNDEPLOYING\"\n }), \"), derived from the live deployment\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"error\"\n }), \": why the last deploy or undeploy failed, null when it succeeded\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"progress\"\n }), \", \", _jsx(_components.code, {\n children: \"eta_seconds\"\n }), \": not wired up yet, always null\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"performance_metrics\"\n }), \", \", _jsx(_components.code, {\n children: \"evaluation_data\"\n }), \": from the model’s latest evaluation, if any\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"usage_count\"\n }), \", \", _jsx(_components.code, {\n children: \"downloadable\"\n }), \": not wired up yet, always 0 and false\"]\n }), \"\\n\", _jsx(_components.li, {\n children: _jsx(_components.code, {\n children: \"inference_capture_enabled\"\n })\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"created_at\"\n }), \", \", _jsx(_components.code, {\n children: \"updated_at\"\n })]\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=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":"Get Model","description":"Get one aligned model by ID.\n\n**Returns:**\n\n- `model_id`, `model_name`, `base_model_id`, `base_model_name`, `alignment_id`\n- `deployment_status` (`UNDEPLOYED`, `DEPLOYING`, `DEPLOYED`, `UNDEPLOYING`), derived from the live deployment\n- `error`: why the last deploy or undeploy failed, null when it succeeded\n- `progress`, `eta_seconds`: not wired up yet, always null\n- `performance_metrics`, `evaluation_data`: from the model's latest evaluation, if any\n- `usage_count`, `downloadable`: not wired up yet, always 0 and false\n- `inference_capture_enabled`\n- `created_at`, `updated_at`","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/models/{model_id}","href":"/api-reference/models/get-model","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Models"],"summary":"Get Model","description":"Get one aligned model by ID.\n\n**Returns:**\n\n- `model_id`, `model_name`, `base_model_id`, `base_model_name`, `alignment_id`\n- `deployment_status` (`UNDEPLOYED`, `DEPLOYING`, `DEPLOYED`, `UNDEPLOYING`), derived from the live deployment\n- `error`: why the last deploy or undeploy failed, null when it succeeded\n- `progress`, `eta_seconds`: not wired up yet, always null\n- `performance_metrics`, `evaluation_data`: from the model's latest evaluation, if any\n- `usage_count`, `downloadable`: not wired up yet, always 0 and false\n- `inference_capture_enabled`\n- `created_at`, `updated_at`","operationId":"models_get","security":["1451d7df-17b1-45ed-9555-ae610147c234"],"parameters":["adf7df20-5d49-4243-8ff4-5d84134655b0"],"responses":{"200":"b82c02ab-f81c-4864-943e-c3035264ce4b","401":"b8a1e462-fd47-43eb-bfe4-5df094c54c20","403":"1148a2cc-8865-4049-9032-b5441b2d7573","404":"ac592e31-76fe-4b30-aa77-7513a4acd818","422":"2e8e77a1-670a-4c83-8a31-5681dc6f8774"},"x-order":10,"method":"get","type":"path","servers":["446c7e81-4e2f-48c8-990b-adca5cc36d70"],"path":"/api/v3/models/{model_id}","baseUrlOptions":["https://api.nugen.in"],"title":"Get Model","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"adf7df20-5d49-4243-8ff4-5d84134655b0":{"name":"model_id","in":"path","required":true,"schema":{"type":"string","title":"Model Id","isRequired":true,"description":"ID of the model, as listed by GET /models/aligned or GET /models/base","uniqueKey":"","typeLabel":"string"},"description":"ID of the model, as listed by GET /models/aligned or GET /models/base"}},"responses":{"b82c02ab-f81c-4864-943e-c3035264ce4b":{"description":"Returns one aligned model: its model_id, model_name, base model, derived deployment status and timestamps.","content":{"application/json":{"schema":{"properties":{"model_id":{"type":"string","title":"Model Id","description":"Unique identifier of the aligned model.","isRequired":true,"uniqueKey":"model_id","typeLabel":"string"},"model_name":{"type":"string","title":"Model Name","description":"Display name of the aligned model.","isRequired":true,"uniqueKey":"model_name","typeLabel":"string"},"base_model_id":{"type":"string","title":"Base Model Id","description":"Base model this model was aligned from.","isRequired":true,"uniqueKey":"base_model_id","typeLabel":"string"},"base_model_name":{"type":"string","title":"Base Model Name","description":"Display name of the base model this model was aligned from.","isRequired":true,"uniqueKey":"base_model_name","typeLabel":"string"},"deployment_status":{"type":"string","enum":["UNDEPLOYED","DEPLOYING","DEPLOYED","UNDEPLOYING"],"title":"DeploymentStatus","description":"Derived from the latest deployment. Only DEPLOYED serves inference.","isRequired":true,"uniqueKey":"deployment_status","typeLabel":"enum\u003cstring>"},"performance_metrics":{"properties":{"accuracy":{"type":"number","maximum":1,"minimum":0,"title":"Accuracy","description":"Model accuracy score from 0.0 to 1.0 (0% to 100%). Represents the proportion of correct responses in evaluations.","default":0,"examples":[0.92,0.88,0.75],"uniqueKey":"performance_metrics.accuracy","typeLabel":"number"},"uncertainty":{"type":"number","maximum":1,"minimum":0,"title":"Uncertainty","description":"Average uncertainty score from 0.0 to 1.0. Lower values indicate higher model confidence in responses.","default":0,"examples":[0.15,0.18,0.35],"uniqueKey":"performance_metrics.uncertainty","typeLabel":"number"},"domain_violations":{"type":"integer","minimum":0,"title":"Domain Violations","description":"Number of times the model responded outside its intended domain or gave an out-of-scope response.","default":0,"examples":[2,3,12],"uniqueKey":"performance_metrics.domain_violations","typeLabel":"integer"},"average_response_time":{"type":"number","minimum":0,"title":"Average Response Time","description":"Average response time in seconds for model inference requests.","default":0,"examples":[1.2,0.8,2.5],"uniqueKey":"performance_metrics.average_response_time","typeLabel":"number"}},"type":"object","title":"ModelPerformanceMetrics","description":"Performance statistics including accuracy, uncertainty, and domain violations","examples":[{"accuracy":0.92,"average_response_time":1.2,"domain_violations":2,"uncertainty":0.15},{"accuracy":0.88,"average_response_time":0.8,"domain_violations":3,"uncertainty":0.18}],"isRequired":true,"uniqueKey":"performance_metrics","typeLabel":"ModelPerformanceMetrics · object"},"alignment_id":{"oneOf":[{"type":"string","title":"Alignment Id","description":"Alignment project that produced this model.","uniqueKey":"alignment_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Alignment Id","description":"Alignment project that produced this model.","uniqueKey":"alignment_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"alignment_id","typeLabel":"string | null"},"error":{"oneOf":[{"type":"string","title":"Error","description":"Why the last deploy or undeploy failed, null when it succeeded.","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","title":"Error","description":"Why the last deploy or undeploy failed, null when it succeeded.","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"string | null"},"progress":{"oneOf":[{"type":"number","title":"Progress","description":"Completion progress, 0.0 to 100.0. Not wired up yet, always null.","uniqueKey":"progress.oneOf.0","typeLabel":"number"},{"type":"null","title":"Progress","description":"Completion progress, 0.0 to 100.0. Not wired up yet, always null.","uniqueKey":"progress.oneOf.1","typeLabel":"null"}],"uniqueKey":"progress","typeLabel":"number | null"},"eta_seconds":{"oneOf":[{"type":"integer","title":"Eta Seconds","description":"Estimated time remaining in seconds. Not wired up yet, always null.","uniqueKey":"eta_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Eta Seconds","description":"Estimated time remaining in seconds. Not wired up yet, always null.","uniqueKey":"eta_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"eta_seconds","typeLabel":"integer | null"},"evaluation_data":{"oneOf":[{"type":"object","title":"Evaluation Data","description":"Benchmark evaluation results if the model has been evaluated (includes evaluation_id, status, metrics, and comparison data)","additionalProperties":true,"uniqueKey":"evaluation_data.oneOf.0","typeLabel":"Evaluation Data · object"},{"type":"null","title":"Evaluation Data","description":"Benchmark evaluation results if the model has been evaluated (includes evaluation_id, status, metrics, and comparison data)","uniqueKey":"evaluation_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"evaluation_data","typeLabel":"Evaluation Data · object | null"},"usage_count":{"type":"integer","title":"Usage Count","description":"Number of times this model has been used for inference","default":0,"uniqueKey":"usage_count","typeLabel":"integer"},"downloadable":{"type":"boolean","title":"Downloadable","description":"Whether the model can be downloaded for local deployment","default":false,"uniqueKey":"downloadable","typeLabel":"boolean"},"inference_capture_enabled":{"type":"boolean","title":"Inference Capture Enabled","description":"Whether instructions and responses for this model are kept, so they can feed train-time alignment. Set with PATCH /api/v3/inference/capture.","default":false,"uniqueKey":"inference_capture_enabled","typeLabel":"boolean"},"created_at":{"oneOf":[{"type":"string","title":"Created At","description":"Creation timestamp.","uniqueKey":"created_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Created At","description":"Creation timestamp.","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"string","title":"Updated At","description":"Last update timestamp.","uniqueKey":"updated_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Updated At","description":"Last update timestamp.","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"string | null"}},"type":"object","required":["model_id","model_name","base_model_id","base_model_name","deployment_status","performance_metrics"],"title":"ModelGetResponse","description":"One aligned model's full record: identity, lineage, live deployment\nstatus and everything on its status and list rows.\n\nprogress and eta_seconds mirror the deployment-status shape but are not\nwired up yet, so they are always null here too. created_at/updated_at are\nthe model's own persisted timestamps, not the deployment status endpoint's\nper-request ones (that endpoint's timestamps mark when a status check\nran, not real historical state, so they are not merged in here).","uniqueKey":"","typeLabel":"ModelGetResponse · object"},"examples":{"Example":{"title":"Example","value":{"model_id":"\u003cstring>","model_name":"\u003cstring>","base_model_id":"\u003cstring>","base_model_name":"\u003cstring>","deployment_status":"UNDEPLOYED","performance_metrics":{"accuracy":0.92,"average_response_time":1.2,"domain_violations":2,"uncertainty":0.15},"alignment_id":"\u003cstring>","error":"\u003cstring>","progress":123,"eta_seconds":123,"evaluation_data":{},"usage_count":0,"downloadable":false,"inference_capture_enabled":false,"created_at":"\u003cstring>","updated_at":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b8a1e462-fd47-43eb-bfe4-5df094c54c20":{"description":"Invalid API key","content":{"application/json":{"schema":{"description":"Body of an error response.","properties":{"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Human readable explanation of the error, or an object with a message and the id of the resource concerned","example":"Model not found","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"object","title":"ErrorDetail","description":"Structured error detail: a message, with the id of the resource it concerns as an extra key.","required":["message"],"example":"Model not found","properties":{"message":{"description":"Human readable explanation of the error","title":"Message","type":"string","isRequired":true,"uniqueKey":"detail.oneOf.1.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"ErrorDetail · object"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | ErrorDetail · object"}},"required":["detail"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"Model not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"1148a2cc-8865-4049-9032-b5441b2d7573":{"description":"Authorization header missing or not a Bearer token","content":{"application/json":{"schema":{"description":"Body of an error response.","properties":{"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Human readable explanation of the error, or an object with a message and the id of the resource concerned","example":"Model not found","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"object","title":"ErrorDetail","description":"Structured error detail: a message, with the id of the resource it concerns as an extra key.","required":["message"],"example":"Model not found","properties":{"message":{"description":"Human readable explanation of the error","title":"Message","type":"string","isRequired":true,"uniqueKey":"detail.oneOf.1.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"ErrorDetail · object"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | ErrorDetail · object"}},"required":["detail"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"Model not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"ac592e31-76fe-4b30-aa77-7513a4acd818":{"description":"Resource not found","content":{"application/json":{"schema":{"description":"Body of an error response.","properties":{"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Human readable explanation of the error, or an object with a message and the id of the resource concerned","example":"Model not found","isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"object","title":"ErrorDetail","description":"Structured error detail: a message, with the id of the resource it concerns as an extra key.","required":["message"],"example":"Model not found","properties":{"message":{"description":"Human readable explanation of the error","title":"Message","type":"string","isRequired":true,"uniqueKey":"detail.oneOf.1.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"ErrorDetail · object"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"string | ErrorDetail · object"}},"required":["detail"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"detail":"Model not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"2e8e77a1-670a-4c83-8a31-5681dc6f8774":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","description":"One request validation problem.","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","description":"Body of a request validation error.","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1451d7df-17b1-45ed-9555-ae610147c234":{"ApiKeyAuth":{"type":"http","description":"Your Nugen API key, sent as a Bearer token","scheme":"bearer","bearerFormat":"API key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"446c7e81-4e2f-48c8-990b-adca5cc36d70":{"url":"https://api.nugen.in","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Your Nugen API key, sent as a Bearer token","scheme":"bearer","bearerFormat":"API key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your Nugen API key, sent as a Bearer token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://api.nugen.in/openapi-public.json"},"subdomain":"courteasy","siteName":"Nugen API Reference Docs","title":"Get Model - Nugen API Reference Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T12:09:16.027Z","originalFileLocation":"api-reference/models/get-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=\"Get one aligned model by ID. Returns: - model_id, model_name, base_model_id, base_model_name, alignment_id - deployment_status (UNDEPLOYED, DEPLOYING, DEPLOYED, UNDEPLOYING), derived from the live deployment - error: why the last deploy or undeploy failed, null when it succeeded - progress, eta_seconds: not wired up yet, always null - performance_metrics, evaluation_data: from the model\u0026#x27;s latest evaluation, if any - usage_count, downloadable: not wired up yet, always 0 and false - inference_capture_enabled - created_at, updated_at\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nugen API Reference Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/courteasy/0D-fi3HjPY3grfJo/_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/courteasy/0D-fi3HjPY3grfJo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/courteasy/0D-fi3HjPY3grfJo/_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/courteasy/0D-fi3HjPY3grfJo/_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/courteasy/0D-fi3HjPY3grfJo/_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/courteasy/0D-fi3HjPY3grfJo/_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/courteasy/0D-fi3HjPY3grfJo/_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/courteasy/0D-fi3HjPY3grfJo/_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/courteasy/0D-fi3HjPY3grfJo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Model - Nugen API Reference Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get one aligned model by ID. Returns: - model_id, model_name, base_model_id, base_model_name, alignment_id - deployment_status (UNDEPLOYED, DEPLOYING, DEPLOYED, UNDEPLOYING), derived from the live deployment - error: why the last deploy or undeploy failed, null when it succeeded - progress, eta_seconds: not wired up yet, always null - performance_metrics, evaluation_data: from the model\u0026#x27;s latest evaluation, if any - usage_count, downloadable: not wired up yet, always 0 and false - inference_capture_enabled - created_at, updated_at\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nugen API Reference Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nugen.in/api-reference/models/get-model\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://courteasy.mintlify.site/_mintlify/api/og/v2?division=Models\u0026amp;title=Get+Model\u0026amp;description=Get+one+aligned+model+by+ID.%0A%0A**Returns%3A**%0A%0A-+%60model_id%60%2C+%60model_name%60%2C+%60base_model_id%60%2C+%60base_model_name%60%2C+%60alignment_id%60%0A-+%60deployment_status%60+%28%60UNDEPLOYED%60%2C+\u0026amp;theme=4bbb9e0a87338e6afdf0d548\u0026amp;signature=4d181c4be53be2a9aabba8b089b52cc305605b6b4d5b4c36a48503da0947ffe1\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Model - Nugen API Reference Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get one aligned model by ID. Returns: - model_id, model_name, base_model_id, base_model_name, alignment_id - deployment_status (UNDEPLOYED, DEPLOYING, DEPLOYED, UNDEPLOYING), derived from the live deployment - error: why the last deploy or undeploy failed, null when it succeeded - progress, eta_seconds: not wired up yet, always null - performance_metrics, evaluation_data: from the model\u0026#x27;s latest evaluation, if any - usage_count, downloadable: not wired up yet, always 0 and false - inference_capture_enabled - created_at, updated_at\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://courteasy.mintlify.site/_mintlify/api/og/v2?division=Models\u0026amp;title=Get+Model\u0026amp;description=Get+one+aligned+model+by+ID.%0A%0A**Returns%3A**%0A%0A-+%60model_id%60%2C+%60model_name%60%2C+%60base_model_id%60%2C+%60base_model_name%60%2C+%60alignment_id%60%0A-+%60deployment_status%60+%28%60UNDEPLOYED%60%2C+\u0026amp;theme=4bbb9e0a87338e6afdf0d548\u0026amp;signature=4d181c4be53be2a9aabba8b089b52cc305605b6b4d5b4c36a48503da0947ffe1\">\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/courteasy/0D-fi3HjPY3grfJo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nugen API Reference Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#005b96\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nugen.in/api-reference/models/get-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/get-model.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nugen.in/#organization\",\"name\":\"Nugen API Reference Docs\",\"url\":\"https://docs.nugen.in\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/courteasy/YYugGl8ZAoQlnBYp/logo/light.svg?fit=max\u0026auto=format\u0026n=YYugGl8ZAoQlnBYp\u0026q=85\u0026s=f5f462b08161252f94dca4827e8055a0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nugen.in#website\",\"name\":\"Nugen API Reference Docs\",\"url\":\"https://docs.nugen.in\",\"publisher\":{\"@id\":\"https://docs.nugen.in/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nugen.in/api-reference/models/get-model#webpage\",\"url\":\"https://docs.nugen.in/api-reference/models/get-model\",\"name\":\"Get Model\",\"description\":\"Get one aligned model by ID. Returns: - model_id, model_name, base_model_id, base_model_name, alignment_id - deployment_status (UNDEPLOYED, DEPLOYING, DEPLOYED, UNDEPLOYING), derived from the live deployment - error: why the last deploy or undeploy failed, null when it succeeded - progress, eta_seconds: not wired up yet, always null - performance_metrics, evaluation_data: from the model's latest evaluation, if any - usage_count, downloadable: not wired up yet, always 0 and false - inference_capture_enabled - created_at, updated_at\",\"dateModified\":\"2026-10-30T12:09:16.027Z\",\"isPartOf\":{\"@id\":\"https://docs.nugen.in#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nugen.in/api-reference/models/get-model#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nugen.in/api-reference/models/get-model#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Models\",\"item\":\"https://docs.nugen.in/api-reference/models/list-base-models\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Model\",\"item\":\"https://docs.nugen.in/api-reference/models/get-model\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nugen.in/api-reference/models/get-model#apireference\",\"headline\":\"Get Model\",\"name\":\"Get Model\",\"description\":\"Get one aligned model by ID. Returns: - model_id, model_name, base_model_id, base_model_name, alignment_id - deployment_status (UNDEPLOYED, DEPLOYING, DEPLOYED, UNDEPLOYING), derived from the live deployment - error: why the last deploy or undeploy failed, null when it succeeded - progress, eta_seconds: not wired up yet, always null - performance_metrics, evaluation_data: from the model's latest evaluation, if any - usage_count, downloadable: not wired up yet, always 0 and false - inference_capture_enabled - created_at, updated_at\",\"url\":\"https://docs.nugen.in/api-reference/models/get-model\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nugen.in/api-reference/models/get-model#webpage\"},\"dateModified\":\"2026-10-30T12:09:16.027Z\",\"publisher\":{\"@id\":\"https://docs.nugen.in/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nugen.in#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nugen API Reference Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Nugen API Reference Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/models/get-model.md","siteName":"Nugen API Reference Docs","nav":{"global":{"anchors":[{"anchor":"API Status","icon":"bolt-lightning","href":"https://status.nugen.in"},{"anchor":"Nugen Intelligence","icon":"earth-asia","href":"https://nugen.in"}]},"tabs":[{"tab":"API Reference","groups":[{"group":"Alignment Projects","pages":[{"title":"Create Alignment","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/alignment-projects/create","href":"/api-reference/alignment-projects/create-alignment"},{"title":"List Alignment Projects","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/alignment-projects/list","href":"/api-reference/alignment-projects/list-alignment-projects"},{"title":"Get Alignment Project","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/alignment-projects/{alignment_id}","href":"/api-reference/alignment-projects/get-alignment-project"},{"title":"Delete Alignment","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json delete /api/v3/alignment-projects/{alignment_id}","href":"/api-reference/alignment-projects/delete-alignment"},{"title":"Get Alignment Status","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/alignment-projects/{alignment_id}/status","href":"/api-reference/alignment-projects/get-alignment-status"},{"title":"Stop Alignment","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/alignment-projects/{alignment_id}/stop","href":"/api-reference/alignment-projects/stop-alignment"},{"title":"Start Auto-Align","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/alignment-projects/{alignment_id}/auto-align","href":"/api-reference/alignment-projects/start-auto-align"}]},{"group":"Models","pages":[{"title":"List Base Models","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/models/base","href":"/api-reference/models/list-base-models"},{"title":"List Aligned Models","description":"Retrieve all domain-aligned models for the authenticated user.\n\nThis endpoint returns a lean list row per aligned model. Fetch `GET /models/{model_id}` for the full record: performance metrics, evaluation data, usage, downloadability and conversation settings.\n\n**Query Parameters:**\n\n- `deployment_status` (optional): `UNDEPLOYED`, `DEPLOYING`, `DEPLOYED` or `UNDEPLOYING`\n- `base_model_id` (optional): exact base model id, e.g. `Qwen/Qwen2.5-0.5B-Instruct`\n- `limit` (optional): Number of models to return (1-100, default: 10)\n- `offset` (optional): Number of models to skip for pagination (default: 0)\n\n**Returns:**\n- `domain_aligned_models`: List of aligned model objects, each containing:\n - `model_id`: Unique model identifier (or `alignment-{id}` for un-deployed models)\n - `model_name`: Model name\n - `deployment_status`: `UNDEPLOYED`, `DEPLOYING`, `DEPLOYED` or `UNDEPLOYING`. Only `DEPLOYED` serves inference.\n - `base_model_id`: Base model used for alignment\n - `alignment_id`: The alignment project that produced this model\n - `created_at`: Creation timestamp\n\n\n**Example Request:**\n\n```json\nGET /api/v3/models/aligned\nHeaders: {\"Authorization\": \"Bearer \u003capi_key>\"}\n```\n\n\n**Example Response:**\n\n```json\n{\n \"domain_aligned_models\": [\n {\n \"model_id\": \"model_01kmqm4nrn9fw6r\",\n \"model_name\": \"customer_support_model\",\n \"deployment_status\": \"DEPLOYED\",\n \"base_model_id\": \"Qwen/Qwen2.5-0.5B-Instruct\",\n \"alignment_id\": \"alignment_01k4x9m2p7q3r8c1\",\n \"created_at\": \"2024-01-15T10:30:00Z\"\n }\n ]\n}\n```\n\n\n**Notes:**\n\n- Returns both deployed and undeployed aligned models\n- Use `/models/base` to see available base models for alignment","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/models/aligned","href":"/api-reference/models/list-aligned-models"},{"title":"Get Model","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/models/{model_id}","href":"/api-reference/models/get-model"},{"title":"Deploy Aligned Model","description":"Deploy an aligned model for inference use.\n\n\nThis endpoint deploys a domain-aligned model, making it available for inference.\n\n\n**Path Parameters:**\n\n- `model_id`: Unique identifier of the aligned model to deploy\n\n\n**Returns:**\n\n- `model_id`: The aligned model being deployed\n\n\n**Raises:**\n\n- `400`: If the model is already deployed, or all 10 deployment slots of your organisation are in use; undeploy a model first\n- `404`: If the model or its alignment project is not found\n- `409`: If the model is still in train-time alignment; pass `early=true` to deploy its newest checkpoint\n\n\n**Example Request:**\n\n```json\nPOST /api/v3/models/{model_id}/deployment\nHeaders: {\"Authorization\": \"Bearer \u003capi_key>\"}\n```\n\n\n**Example Response:**\n\n```json\n{\"model_id\": \"model_01kmqm4nrn9fw6r\"}\n```\n\n\n**Notes:**\n\n- Deployment is asynchronous and may take 5-15 minutes to complete\n- Poll `GET /api/v3/models/{model_id}/deployment/status`; on `FAILED` the failure reason is in `result.error`\n- Once deployed, the model will be available at its inference endpoint\n- Model must be in `UNDEPLOYED` state before deployment","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/models/{model_id}/deployment","href":"/api-reference/models/deploy-aligned-model"},{"title":"Undeploy Model","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json delete /api/v3/models/{model_id}/deployment","href":"/api-reference/models/undeploy-model"},{"title":"Get Deployment Status","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/models/{model_id}/deployment/status","href":"/api-reference/models/get-deployment-status"},{"title":"Refresh Deployed Model","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/models/{model_id}/deployment/refresh","href":"/api-reference/models/refresh-deployed-model"},{"title":"Export to Hugging Face","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/models/{model_id}/export-hf","href":"/api-reference/models/export-to-hugging-face"},{"title":"Import from Hugging Face","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/models/base/import","href":"/api-reference/models/import-from-hugging-face"},{"title":"Get the status of a Hugging Face export","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/models/{model_id}/export-hf/status","href":"/api-reference/models/get-the-status-of-a-hugging-face-export"}]},{"group":"Documents","pages":[{"title":"Upload Documents","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/documents/create","href":"/api-reference/documents/upload-documents"},{"title":"List Documents","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/documents/list","href":"/api-reference/documents/list-documents"},{"title":"Get Document Status","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/documents/{document_id}/status","href":"/api-reference/documents/get-document-status"},{"title":"Get Document","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/documents/{document_id}","href":"/api-reference/documents/get-document"},{"title":"Delete Document","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json delete /api/v3/documents/{document_id}","href":"/api-reference/documents/delete-document"}]},{"group":"Benchmarks","pages":[{"title":"Create Benchmark","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/benchmarks/create","href":"/api-reference/benchmarks/create-benchmark"},{"title":"Upload Benchmark","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/benchmarks/upload","href":"/api-reference/benchmarks/upload-benchmark"},{"title":"List Benchmarks","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/benchmarks/list","href":"/api-reference/benchmarks/list-benchmarks"},{"title":"Get Benchmark","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/benchmarks/{benchmark_id}","href":"/api-reference/benchmarks/get-benchmark"},{"title":"Delete Benchmark","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json delete /api/v3/benchmarks/{benchmark_id}","href":"/api-reference/benchmarks/delete-benchmark"},{"title":"Get Benchmark Status","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/benchmarks/{benchmark_id}/status","href":"/api-reference/benchmarks/get-benchmark-status"},{"title":"Get Generated Benchmark","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/benchmarks/{benchmark_id}/data","href":"/api-reference/benchmarks/get-generated-benchmark"}]},{"group":"Evaluations","pages":[{"title":"Create Evaluation","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/evaluations/create","href":"/api-reference/evaluations/create-evaluation"},{"title":"List User Evaluations","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/evaluations/list","href":"/api-reference/evaluations/list-user-evaluations"},{"title":"Get Evaluation","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/evaluations/{evaluation_id}","href":"/api-reference/evaluations/get-evaluation"},{"title":"Delete Evaluation","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json delete /api/v3/evaluations/{evaluation_id}","href":"/api-reference/evaluations/delete-evaluation"},{"title":"Get Evaluation Status","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/evaluations/{evaluation_id}/status","href":"/api-reference/evaluations/get-evaluation-status"},{"title":"Get Evaluation Results","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/evaluations/{evaluation_id}/results","href":"/api-reference/evaluations/get-evaluation-results"}]},{"group":"Inference","pages":[{"title":"Generate Embeddings","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/inference/embeddings","href":"/api-reference/inference/generate-embeddings"},{"title":"Generate Chat Completions","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/inference/chat/completions","href":"/api-reference/inference/generate-chat-completions"},{"title":"OpenAI-compatible Responses","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/inference/responses","href":"/api-reference/inference/openai-compatible-responses"},{"title":"Rerank Documents","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/inference/reranker","href":"/api-reference/inference/rerank-documents"},{"title":"Inference Settings","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/inference/capture","href":"/api-reference/inference/inference-settings"}]},{"group":"BYOC","pages":[{"title":"Deploy in your own cloud or cluster","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/byoc/clusters","href":"/api-reference/byoc/deploy-in-your-own-cloud-or-cluster"},{"title":"Get Cluster Health","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /api/v3/byoc/clusters/{cluster_id}/status","href":"/api-reference/byoc/get-cluster-health"}]},{"group":"Health","pages":[{"title":"API Health","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json get /health","href":"/api-reference/health/api-health"}]}]}]},"basePath":"","title":"Get Model - Nugen API Reference Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}