Retrieve all domain-aligned models for the authenticated user.
This 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.
Query Parameters:
deployment_status (optional): UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING
base_model_id (optional): exact base model id, e.g. Qwen/Qwen2.5-0.5B-Instruct
limit (optional): Number of models to return (1-100, default: 10)
offset (optional): Number of models to skip for pagination (default: 0)
Returns:
domain_aligned_models: List of aligned model objects, each containing:
model_id: Unique model identifier (or alignment-{id} for un-deployed models)
model_name: Model name
deployment_status: UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING. Only DEPLOYED serves inference.
base_model_id: Base model used for alignment
alignment_id: The alignment project that produced this model
created_at: Creation timestamp
Example Request:
GET /api/v3/models/alignedHeaders: {"Authorization": "Bearer <api_key>"}
Only models in this deployment state
Where a model rests, and what it passes through in between. Only
DEPLOYED serves inference. A failed attempt settles back to the state it
came from and puts the reason in error.
One summary row per aligned model. Performance metrics and evaluation data are served by GET /models/{model_id}.
Show child attributes
Was this page helpful?
{"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":""},"chroma":{"liveDeploymentHistoryId":"6ae488e3c69c99d3b7d10d90","collectionId":"40434be0-cf82-41a3-a286-8ff8a4cc7e42","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae488e3c69c99d3b7d10d90"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae488e3c69c99d3b7d10d90","clientVersion":"0.0.4044","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":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/models/list-aligned-models","slug":"/api-reference/models/list-aligned-models","pageMetadata":{"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","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 pre: \"pre\",\n span: \"span\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {CodeBlock} = _components;\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve all domain-aligned models for the authenticated user.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This endpoint returns a lean list row per aligned model. Fetch \", _jsx(_components.code, {\n children: \"GET /models/{model_id}\"\n }), \" for the full record: performance metrics, evaluation data, usage, downloadability and conversation settings.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Query Parameters:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"deployment_status\"\n }), \" (optional): \", _jsx(_components.code, {\n children: \"UNDEPLOYED\"\n }), \", \", _jsx(_components.code, {\n children: \"DEPLOYING\"\n }), \", \", _jsx(_components.code, {\n children: \"DEPLOYED\"\n }), \" or \", _jsx(_components.code, {\n children: \"UNDEPLOYING\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"base_model_id\"\n }), \" (optional): exact base model id, e.g. \", _jsx(_components.code, {\n children: \"Qwen/Qwen2.5-0.5B-Instruct\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"limit\"\n }), \" (optional): Number of models to return (1-100, default: 10)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"offset\"\n }), \" (optional): Number of models to skip for pagination (default: 0)\"]\n }), \"\\n\"]\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: \"domain_aligned_models\"\n }), \": List of aligned model objects, each containing:\", \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"model_id\"\n }), \": Unique model identifier (or \", _jsx(_components.code, {\n children: \"alignment-{id}\"\n }), \" for un-deployed models)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"model_name\"\n }), \": Model name\"]\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 }), \" or \", _jsx(_components.code, {\n children: \"UNDEPLOYING\"\n }), \". Only \", _jsx(_components.code, {\n children: \"DEPLOYED\"\n }), \" serves inference.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"base_model_id\"\n }), \": Base model used for alignment\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"alignment_id\"\n }), \": The alignment project that produced this model\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"created_at\"\n }), \": Creation timestamp\"]\n }), \"\\n\"]\n }), \"\\n\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example Request:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"2\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"2\",\n children: [_jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"GET /api/v\"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#B5CEA8\"\n },\n children: \"3\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"/models/aligned\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"Headers: {\"\n }), _jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \"\\\"Authorization\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Bearer \u003capi_key>\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })]\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example Response:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"12\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"12\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"domain_aligned_models\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": [\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" {\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"model_id\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"model_01kmqm4nrn9fw6r\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"model_name\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"customer_support_model\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"deployment_status\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"DEPLOYED\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"base_model_id\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Qwen/Qwen2.5-0.5B-Instruct\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"alignment_id\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"alignment_01k4x9m2p7q3r8c1\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"created_at\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"2024-01-15T10:30:00Z\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" }\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" ]\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Notes:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Returns both deployed and undeployed aligned models\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Use \", _jsx(_components.code, {\n children: \"/models/base\"\n }), \" to see available base models for alignment\"]\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};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\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":"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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Models"],"summary":"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","operationId":"models_list_aligned","security":["f88d1783-edcd-4cf0-b355-c88394d91011"],"parameters":["36ed7687-5eb5-4cef-a9fb-d38586ea2afa","3ae6f539-a149-4944-8b34-1e301f884fdc","1696327b-0f02-4261-b0c8-15638b45115c","a0d2c9c2-c31a-4a0b-b264-d956504ea84a"],"responses":{"200":"75275ee2-410f-450f-9768-2afa85f324af","400":"84c127ec-6c5f-4b2c-bace-8e1e7c55bbbb","401":"341f6f34-8569-4ebe-854f-670ae4e6d5a2","403":"bddf56a3-360a-439a-b602-f13d6ec4ddaa","404":"8618265c-25c6-4981-8349-801f160235c0","422":"c539f9e5-3341-4be6-ad70-ff38fe983a33"},"x-order":9,"method":"get","type":"path","servers":["446c7e81-4e2f-48c8-990b-adca5cc36d70"],"path":"/api/v3/models/aligned","baseUrlOptions":["https://api.nugen.in"],"title":"List Aligned Models","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"36ed7687-5eb5-4cef-a9fb-d38586ea2afa":{"name":"deployment_status","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"DeploymentStatus","description":"Only models in this deployment state\nWhere a model rests, and what it passes through in between. Only\nDEPLOYED serves inference. A failed attempt settles back to the state it\ncame from and puts the reason in error.","enum":["UNDEPLOYED","DEPLOYING","DEPLOYED","UNDEPLOYING"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Deployment Status","description":"Only models in this deployment state","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"},"description":"Only models in this deployment state"},"3ae6f539-a149-4944-8b34-1e301f884fdc":{"name":"base_model_id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Base Model Id","description":"Only models aligned from this base model, by exact id","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Base Model Id","description":"Only models aligned from this base model, by exact id","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Only models aligned from this base model, by exact id"},"1696327b-0f02-4261-b0c8-15638b45115c":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of models to return","default":10,"title":"Limit","isRequired":false,"uniqueKey":"","typeLabel":"integer"},"description":"Number of models to return"},"a0d2c9c2-c31a-4a0b-b264-d956504ea84a":{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of models to skip","default":0,"title":"Offset","isRequired":false,"uniqueKey":"","typeLabel":"integer"},"description":"Number of models to skip"}},"responses":{"75275ee2-410f-450f-9768-2afa85f324af":{"description":"Returns a list of all domain-aligned models created by the authenticated user.","content":{"application/json":{"schema":{"properties":{"domain_aligned_models":{"items":{"properties":{"model_id":{"type":"string","title":"Model Id","description":"Unique identifier for the aligned model","examples":["model_01k4x9m2p7q3r9d1","model_01k4x9m2p7q3r9d2"],"isRequired":true,"uniqueKey":"domain_aligned_models.items.[INDEX].model_id","typeLabel":"string"},"model_name":{"type":"string","title":"Model Name","description":"Human-readable name assigned to the aligned model","examples":["contract_risk_model","clinical_coding_model","claims_adjudication"],"isRequired":true,"uniqueKey":"domain_aligned_models.items.[INDEX].model_name","typeLabel":"string"},"deployment_status":{"oneOf":[{"type":"string","title":"DeploymentStatus","description":"Live deployment state. Only DEPLOYED serves inference; UNDEPLOYED is deployable.","enum":["UNDEPLOYED","DEPLOYING","DEPLOYED","UNDEPLOYING"],"isRequired":true,"uniqueKey":"domain_aligned_models.items.[INDEX].deployment_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Live deployment state. Only DEPLOYED serves inference; UNDEPLOYED is deployable.","isRequired":true,"uniqueKey":"domain_aligned_models.items.[INDEX].deployment_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"domain_aligned_models.items.[INDEX].deployment_status","typeLabel":"enum\u003cstring> | null"},"base_model_id":{"type":"string","title":"Base Model Id","description":"ID of the base model used for domain alignment","examples":["Qwen/Qwen2.5-0.5B-Instruct","Qwen/Qwen2.5-1.5B-Instruct"],"isRequired":true,"uniqueKey":"domain_aligned_models.items.[INDEX].base_model_id","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the model was created","examples":["2024-01-15T10:30:00Z"],"isRequired":true,"uniqueKey":"domain_aligned_models.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"alignment_id":{"oneOf":[{"type":"string","title":"Alignment Id","description":"The alignment project that produced this model; each alignment produces at most one model","example":"alignment_01k4x9m2p7q3r8c1","uniqueKey":"domain_aligned_models.items.[INDEX].alignment_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Alignment Id","description":"The alignment project that produced this model; each alignment produces at most one model","example":"alignment_01k4x9m2p7q3r8c1","uniqueKey":"domain_aligned_models.items.[INDEX].alignment_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"domain_aligned_models.items.[INDEX].alignment_id","typeLabel":"string | null"}},"type":"object","required":["model_id","model_name","deployment_status","base_model_id","created_at"],"title":"ModelListAlignedItem","description":"One aligned model in a list.","examples":[{"alignment_id":"alignment_01k4x9m2p7q3r8c1","base_model_id":"Qwen/Qwen2.5-0.5B-Instruct","created_at":"2024-01-15T10:30:00Z","deployment_status":"DEPLOYED","model_id":"model_01k4x9m2p7q3r9d1","model_name":"contract_risk_model"}],"uniqueKey":"domain_aligned_models.items.[INDEX]","typeLabel":"ModelListAlignedItem · object"},"type":"array","title":"Domain Aligned Models","description":"One summary row per aligned model. Performance metrics and evaluation data are served by GET /models/{model_id}.","isRequired":true,"uniqueKey":"domain_aligned_models","typeLabel":"ModelListAlignedItem · object[]"}},"type":"object","required":["domain_aligned_models"],"title":"ModelListAlignedResponse","description":"The caller's aligned models.","examples":[{"domain_aligned_models":[{"base_model_id":"Qwen/Qwen2.5-0.5B-Instruct","base_model_name":"Qwen/Qwen2.5-0.5B-Instruct","created_at":"2024-01-15T10:30:00Z","deployment_status":"DEPLOYED","model_id":"model_01k4x9m2p7q3r9d1","model_name":"model_contract_risk"},{"base_model_id":"Qwen/Qwen2.5-1.5B-Instruct","base_model_name":"Llama V3p3 70b Instruct","created_at":"2024-02-01T09:15:00Z","deployment_status":"UNDEPLOYED","model_id":"model_01k4x9m2p7q3r9d2","model_name":"model_clinical_coding"}]}],"uniqueKey":"","typeLabel":"ModelListAlignedResponse · object"},"examples":{"Example":{"title":"Example","value":{"domain_aligned_models":[{"base_model_id":"Qwen/Qwen2.5-0.5B-Instruct","base_model_name":"Qwen/Qwen2.5-0.5B-Instruct","created_at":"2024-01-15T10:30:00Z","deployment_status":"DEPLOYED","model_id":"model_01k4x9m2p7q3r9d1","model_name":"model_contract_risk"},{"base_model_id":"Qwen/Qwen2.5-1.5B-Instruct","base_model_name":"Llama V3p3 70b Instruct","created_at":"2024-02-01T09:15:00Z","deployment_status":"UNDEPLOYED","model_id":"model_01k4x9m2p7q3r9d2","model_name":"model_clinical_coding"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"84c127ec-6c5f-4b2c-bace-8e1e7c55bbbb":{"description":"Bad request - invalid query parameters","content":{"application/json":{"example":{"detail":"Bad request"},"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":"Bad request"}}},"exampleType":"examples"}},"exampleType":"examples"},"341f6f34-8569-4ebe-854f-670ae4e6d5a2":{"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"},"bddf56a3-360a-439a-b602-f13d6ec4ddaa":{"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"},"8618265c-25c6-4981-8349-801f160235c0":{"description":"No aligned models found for the authenticated user","content":{"application/json":{"example":{"detail":"No aligned models found"},"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":"No aligned models found"}}},"exampleType":"examples"}},"exampleType":"examples"},"c539f9e5-3341-4be6-ad70-ff38fe983a33":{"description":"Validation error - invalid request parameters","content":{"application/json":{"example":{"detail":[{"loc":["header","Authorization"],"msg":"field required","type":"value_error.missing"}]},"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":["header","Authorization"],"msg":"field required","type":"value_error.missing"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"f88d1783-edcd-4cf0-b355-c88394d91011":{"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":"List Aligned Models - Nugen API Reference Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T12:09:16.011Z","originalFileLocation":"api-reference/models/list-aligned-models.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=\"Retrieve all domain-aligned models for the authenticated user. This 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. Query Parameters: - deployment_status (optional): UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING - base_model_id (optional): exact base model id, e.g. Qwen/Qwen2.5-0.5B-Instruct - limit (optional): Number of models to return (1-100, default: 10) - offset (optional): Number of models to skip for pagination (default: 0) Returns: - domain_aligned_models: List of aligned model objects, each containing: - model_id: Unique model identifier (or alignment-{id} for un-deployed models) - model_name: Model name - deployment_status: UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING. Only DEPLOYED serves inference. - base_model_id: Base model used for alignment - alignment_id: The alignment project that produced this model - created_at: Creation timestamp Example Request: json GET /api/v3/models/aligned Headers: {\u0026quot;Authorization\u0026quot;: \u0026quot;Bearer \u0026quot;} Example Response: json { \u0026quot;domain_aligned_models\u0026quot;: [ { \u0026quot;model_id\u0026quot;: \u0026quot;model_01kmqm4nrn9fw6r\u0026quot;, \u0026quot;model_name\u0026quot;: \u0026quot;customer_support_model\u0026quot;, \u0026quot;deployment_status\u0026quot;: \u0026quot;DEPLOYED\u0026quot;, \u0026quot;base_model_id\u0026quot;: \u0026quot;Qwen/Qwen2.5-0.5B-Instruct\u0026quot;, \u0026quot;alignment_id\u0026quot;: \u0026quot;alignment_01k4x9m2p7q3r8c1\u0026quot;, \u0026quot;created_at\u0026quot;: \u0026quot;2024-01-15T10:30:00Z\u0026quot; } ] } Notes: - Returns both deployed and undeployed aligned models - Use /models/base to see available base models for alignment\">\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=\"List Aligned Models - Nugen API Reference Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve all domain-aligned models for the authenticated user. This 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. Query Parameters: - deployment_status (optional): UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING - base_model_id (optional): exact base model id, e.g. Qwen/Qwen2.5-0.5B-Instruct - limit (optional): Number of models to return (1-100, default: 10) - offset (optional): Number of models to skip for pagination (default: 0) Returns: - domain_aligned_models: List of aligned model objects, each containing: - model_id: Unique model identifier (or alignment-{id} for un-deployed models) - model_name: Model name - deployment_status: UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING. Only DEPLOYED serves inference. - base_model_id: Base model used for alignment - alignment_id: The alignment project that produced this model - created_at: Creation timestamp Example Request: json GET /api/v3/models/aligned Headers: {\u0026quot;Authorization\u0026quot;: \u0026quot;Bearer \u0026quot;} Example Response: json { \u0026quot;domain_aligned_models\u0026quot;: [ { \u0026quot;model_id\u0026quot;: \u0026quot;model_01kmqm4nrn9fw6r\u0026quot;, \u0026quot;model_name\u0026quot;: \u0026quot;customer_support_model\u0026quot;, \u0026quot;deployment_status\u0026quot;: \u0026quot;DEPLOYED\u0026quot;, \u0026quot;base_model_id\u0026quot;: \u0026quot;Qwen/Qwen2.5-0.5B-Instruct\u0026quot;, \u0026quot;alignment_id\u0026quot;: \u0026quot;alignment_01k4x9m2p7q3r8c1\u0026quot;, \u0026quot;created_at\u0026quot;: \u0026quot;2024-01-15T10:30:00Z\u0026quot; } ] } Notes: - Returns both deployed and undeployed aligned models - Use /models/base to see available base models for alignment\">\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/list-aligned-models\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://courteasy.mintlify.app/_mintlify/api/og/v2?division=Models\u0026amp;title=List+Aligned+Models\u0026amp;description=Retrieve+all+domain-aligned+models+for+the+authenticated+user.%0A%0AThis+endpoint+returns+a+lean+list+row+per+aligned+model.+Fetch+%60GET+%2Fmodels%2F%7Bmodel_id%7D%60+for+the+\u0026amp;theme=8395e2aaefdebbd3e68b298e\u0026amp;signature=a8e533ddd628776ea62182b5592eb20538213c6a0828779313f76aeee233674c\">\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=\"List Aligned Models - Nugen API Reference Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve all domain-aligned models for the authenticated user. This 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. Query Parameters: - deployment_status (optional): UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING - base_model_id (optional): exact base model id, e.g. Qwen/Qwen2.5-0.5B-Instruct - limit (optional): Number of models to return (1-100, default: 10) - offset (optional): Number of models to skip for pagination (default: 0) Returns: - domain_aligned_models: List of aligned model objects, each containing: - model_id: Unique model identifier (or alignment-{id} for un-deployed models) - model_name: Model name - deployment_status: UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING. Only DEPLOYED serves inference. - base_model_id: Base model used for alignment - alignment_id: The alignment project that produced this model - created_at: Creation timestamp Example Request: json GET /api/v3/models/aligned Headers: {\u0026quot;Authorization\u0026quot;: \u0026quot;Bearer \u0026quot;} Example Response: json { \u0026quot;domain_aligned_models\u0026quot;: [ { \u0026quot;model_id\u0026quot;: \u0026quot;model_01kmqm4nrn9fw6r\u0026quot;, \u0026quot;model_name\u0026quot;: \u0026quot;customer_support_model\u0026quot;, \u0026quot;deployment_status\u0026quot;: \u0026quot;DEPLOYED\u0026quot;, \u0026quot;base_model_id\u0026quot;: \u0026quot;Qwen/Qwen2.5-0.5B-Instruct\u0026quot;, \u0026quot;alignment_id\u0026quot;: \u0026quot;alignment_01k4x9m2p7q3r8c1\u0026quot;, \u0026quot;created_at\u0026quot;: \u0026quot;2024-01-15T10:30:00Z\u0026quot; } ] } Notes: - Returns both deployed and undeployed aligned models - Use /models/base to see available base models for alignment\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://courteasy.mintlify.app/_mintlify/api/og/v2?division=Models\u0026amp;title=List+Aligned+Models\u0026amp;description=Retrieve+all+domain-aligned+models+for+the+authenticated+user.%0A%0AThis+endpoint+returns+a+lean+list+row+per+aligned+model.+Fetch+%60GET+%2Fmodels%2F%7Bmodel_id%7D%60+for+the+\u0026amp;theme=8395e2aaefdebbd3e68b298e\u0026amp;signature=a8e533ddd628776ea62182b5592eb20538213c6a0828779313f76aeee233674c\">\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/list-aligned-models\">\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/list-aligned-models.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/list-aligned-models#webpage\",\"url\":\"https://docs.nugen.in/api-reference/models/list-aligned-models\",\"name\":\"List Aligned Models\",\"description\":\"Retrieve all domain-aligned models for the authenticated user. This 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. Query Parameters: - deployment_status (optional): UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING - base_model_id (optional): exact base model id, e.g. Qwen/Qwen2.5-0.5B-Instruct - limit (optional): Number of models to return (1-100, default: 10) - offset (optional): Number of models to skip for pagination (default: 0) Returns: - domain_aligned_models: List of aligned model objects, each containing: - model_id: Unique model identifier (or alignment-{id} for un-deployed models) - model_name: Model name - deployment_status: UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING. Only DEPLOYED serves inference. - base_model_id: Base model used for alignment - alignment_id: The alignment project that produced this model - created_at: Creation timestamp Example Request: json GET /api/v3/models/aligned Headers: {\\\"Authorization\\\": \\\"Bearer \\\"} Example Response: json { \\\"domain_aligned_models\\\": [ { \\\"model_id\\\": \\\"model_01kmqm4nrn9fw6r\\\", \\\"model_name\\\": \\\"customer_support_model\\\", \\\"deployment_status\\\": \\\"DEPLOYED\\\", \\\"base_model_id\\\": \\\"Qwen/Qwen2.5-0.5B-Instruct\\\", \\\"alignment_id\\\": \\\"alignment_01k4x9m2p7q3r8c1\\\", \\\"created_at\\\": \\\"2024-01-15T10:30:00Z\\\" } ] } Notes: - Returns both deployed and undeployed aligned models - Use /models/base to see available base models for alignment\",\"dateModified\":\"2026-10-30T12:09:16.011Z\",\"isPartOf\":{\"@id\":\"https://docs.nugen.in#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nugen.in/api-reference/models/list-aligned-models#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nugen.in/api-reference/models/list-aligned-models#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Models\",\"item\":\"https://docs.nugen.in/api-reference/models/list-base-models\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Aligned Models\",\"item\":\"https://docs.nugen.in/api-reference/models/list-aligned-models\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nugen.in/api-reference/models/list-aligned-models#apireference\",\"headline\":\"List Aligned Models\",\"name\":\"List Aligned Models\",\"description\":\"Retrieve all domain-aligned models for the authenticated user. This 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. Query Parameters: - deployment_status (optional): UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING - base_model_id (optional): exact base model id, e.g. Qwen/Qwen2.5-0.5B-Instruct - limit (optional): Number of models to return (1-100, default: 10) - offset (optional): Number of models to skip for pagination (default: 0) Returns: - domain_aligned_models: List of aligned model objects, each containing: - model_id: Unique model identifier (or alignment-{id} for un-deployed models) - model_name: Model name - deployment_status: UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING. Only DEPLOYED serves inference. - base_model_id: Base model used for alignment - alignment_id: The alignment project that produced this model - created_at: Creation timestamp Example Request: json GET /api/v3/models/aligned Headers: {\\\"Authorization\\\": \\\"Bearer \\\"} Example Response: json { \\\"domain_aligned_models\\\": [ { \\\"model_id\\\": \\\"model_01kmqm4nrn9fw6r\\\", \\\"model_name\\\": \\\"customer_support_model\\\", \\\"deployment_status\\\": \\\"DEPLOYED\\\", \\\"base_model_id\\\": \\\"Qwen/Qwen2.5-0.5B-Instruct\\\", \\\"alignment_id\\\": \\\"alignment_01k4x9m2p7q3r8c1\\\", \\\"created_at\\\": \\\"2024-01-15T10:30:00Z\\\" } ] } Notes: - Returns both deployed and undeployed aligned models - Use /models/base to see available base models for alignment\",\"url\":\"https://docs.nugen.in/api-reference/models/list-aligned-models\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nugen.in/api-reference/models/list-aligned-models#webpage\"},\"dateModified\":\"2026-10-30T12:09:16.011Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","description":"Retrieve the list of available base models.\n\n\nThis endpoint returns all general-purpose base models available for use in chat completions, embeddings, and domain alignment workflows.\n\n\n**Query Parameters:**\n\n- `alignment_ready` (optional): `true` or `false`\n- `inference_ready` (optional): `true` or `false`\n- `type` (optional): `text-generation` or `image-text-to-text`\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\n**Returns:**\n\n- `models`: List of base model objects, each containing:\n - `model_id`: Unique model identifier\n - `model_name`: Human-readable model name\n - `parameters`: Model parameter count\n - `alignment_ready`: Whether model can be used as a base for domain alignment\n - `inference_ready`: Whether model is deployed for chat, completions, embeddings or rerank\n - `available_on_request`: Whether this model requires an access request before use\n - `type`: Hugging Face `pipeline_tag`, `text-generation` or `image-text-to-text`. Embedding and reranking base models are not listed; use an aligned model id for both\n - `model_card`: URL of the model card README on Hugging Face\n\n\n**Example Request:**\n\n```json\nGET /api/v3/models/base\nHeaders: {\"Authorization\": \"Bearer \u003capi_key>\"}\n```\n\n\n**Example Response:**\n\n```json\n{\n \"models\": [\n {\n \"model_id\": \"Qwen/Qwen2.5-0.5B-Instruct\",\n \"model_name\": \"Qwen/Qwen2.5-0.5B-Instruct\",\n \"parameters\": \"0.49B\",\n \"alignment_ready\": true,\n \"inference_ready\": true,\n \"available_on_request\": false,\n \"type\": \"text-generation\",\n \"model_card\": \"https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct/blob/main/README.md\"\n },\n {\n \"model_id\": \"nomic-ai/nomic-embed-text-v1.5\",\n \"model_name\": \"nomic-ai/nomic-embed-text-v1.5\",\n \"parameters\": \"0.14B\",\n \"alignment_ready\": false,\n \"inference_ready\": true,\n \"available_on_request\": false,\n \"type\": \"embedding\",\n \"model_card\": \"https://huggingface.co/nomic-ai/nomic-embed-text-v1.5/blob/main/README.md\"\n }\n ]\n}\n```\n**Notes:**\n\n- Base models are general-purpose starting points for domain alignment\n- These models can be used directly or as base models for domain alignment\n- Use `/models/aligned` to see your custom domain-aligned models\n- `alignment_ready` indicates if the model can be used as a base for domain alignment","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","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","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"},{"title":"Deploy Aligned Model","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":"List Aligned Models - Nugen API Reference Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}