This endpoint returns all general-purpose base models available for use in chat completions, embeddings, and domain alignment workflows.
Query Parameters:
alignment_ready (optional): true or false
inference_ready (optional): true or false
type (optional): text-generation or image-text-to-text
limit (optional): Number of models to return (1-100, default: 10)
offset (optional): Number of models to skip for pagination (default: 0)
Returns:
models: List of base model objects, each containing:
model_id: Unique model identifier
model_name: Human-readable model name
parameters: Model parameter count
alignment_ready: Whether model can be used as a base for domain alignment
inference_ready: Whether model is deployed for chat, completions, embeddings or rerank
available_on_request: Whether this model requires an access request before use
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
model_card: URL of the model card README on Hugging Face
Example Request:
GET /api/v3/models/baseHeaders: {"Authorization": "Bearer <api_key>"}
{"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":"6ac0575f092d34e8f6dee6a2","collectionId":"847f6396-6348-4904-9e67-2603c1208254","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac0575f092d34e8f6dee6a2"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ac0575f092d34e8f6dee6a2","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":41},{"language":"default","tag":"Models","count":9},{"language":"default","tag":"Benchmarks","count":7},{"language":"default","tag":"Model Alignment","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}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/models/list-base-models","slug":"/api-reference/models/list-base-models","pageMetadata":{"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","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 the list of available base models.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"This endpoint returns all general-purpose base models available for use in chat completions, embeddings, and domain alignment workflows.\"\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: \"alignment_ready\"\n }), \" (optional): \", _jsx(_components.code, {\n children: \"true\"\n }), \" or \", _jsx(_components.code, {\n children: \"false\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"inference_ready\"\n }), \" (optional): \", _jsx(_components.code, {\n children: \"true\"\n }), \" or \", _jsx(_components.code, {\n children: \"false\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"type\"\n }), \" (optional): \", _jsx(_components.code, {\n children: \"text-generation\"\n }), \" or \", _jsx(_components.code, {\n children: \"image-text-to-text\"\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: \"models\"\n }), \": List of base 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\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"model_name\"\n }), \": Human-readable model name\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"parameters\"\n }), \": Model parameter count\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"alignment_ready\"\n }), \": Whether model can be used as a base for domain alignment\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"inference_ready\"\n }), \": Whether model is deployed for chat, completions, embeddings or rerank\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"available_on_request\"\n }), \": Whether this model requires an access request before use\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"type\"\n }), \": Hugging Face \", _jsx(_components.code, {\n children: \"pipeline_tag\"\n }), \", \", _jsx(_components.code, {\n children: \"text-generation\"\n }), \" or \", _jsx(_components.code, {\n children: \"image-text-to-text\"\n }), \". Embedding and reranking base models are not listed; use an aligned model id for both\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"model_card\"\n }), \": URL of the model card README on Hugging Face\"]\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/base\"\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: \"24\",\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: \"24\",\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: \" \\\"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: \"\\\"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: \" \\\"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: \"\\\"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: \" \\\"parameters\\\"\"\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: \"\\\"0.49B\\\"\"\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_ready\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \"true\"\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: \" \\\"inference_ready\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \"true\"\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: \" \\\"available_on_request\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \"false\"\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: \" \\\"type\\\"\"\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: \"\\\"text-generation\\\"\"\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_card\\\"\"\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: \"\\\"https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct/blob/main/README.md\\\"\"\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\", _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: \"\\\"nomic-ai/nomic-embed-text-v1.5\\\"\"\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: \"\\\"nomic-ai/nomic-embed-text-v1.5\\\"\"\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: \" \\\"parameters\\\"\"\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: \"\\\"0.14B\\\"\"\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_ready\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \"false\"\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: \" \\\"inference_ready\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \"true\"\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: \" \\\"available_on_request\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#569CD6\"\n },\n children: \"false\"\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: \" \\\"type\\\"\"\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: \"\\\"embedding\\\"\"\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_card\\\"\"\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: \"\\\"https://huggingface.co/nomic-ai/nomic-embed-text-v1.5/blob/main/README.md\\\"\"\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: \"Base models are general-purpose starting points for domain alignment\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"These models can be used directly or as base models for domain alignment\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Use \", _jsx(_components.code, {\n children: \"/models/aligned\"\n }), \" to see your custom domain-aligned models\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"alignment_ready\"\n }), \" indicates if the model can be used as a base for domain 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 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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Models"],"summary":"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","operationId":"list_base_models","security":["77c00d76-4533-46fa-928d-64e58fd97d0a"],"parameters":["d038fa2e-2d82-4534-aab5-f5089a3ac1ce","a98e4d3c-7cc4-4db9-8878-a2e559491a64","8119e39c-d680-4f66-aacf-cce79313e336","523f02fa-2cd5-46ba-a742-a0e98d7a1e7e","7f4f834c-f507-485f-bee2-d8f9f48ba992"],"responses":{"200":"99a1e575-58b1-4a4f-8b31-285d7d298193","400":"15797a75-0299-4547-ad64-d003487f5f57","404":"e5c57de4-cbd8-4583-bdda-156f3579455b","422":"b5ccfc2e-63bc-4832-8e90-4ba4bd1ae441"},"x-order":8,"method":"get","type":"path","servers":["4e0c5fe7-c647-4e78-83c7-67b873654cb6"],"path":"/api/v3/models/base","baseUrlOptions":["https://api.nugen.in"],"title":"List Base Models","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d038fa2e-2d82-4534-aab5-f5089a3ac1ce":{"name":"alignment_ready","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Alignment Ready","description":"Only models that can, or cannot, be aligned","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Alignment Ready","description":"Only models that can, or cannot, be aligned","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"},"description":"Only models that can, or cannot, be aligned"},"a98e4d3c-7cc4-4db9-8878-a2e559491a64":{"name":"inference_ready","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Inference Ready","description":"Only models that are, or are not, deployed for inference","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Inference Ready","description":"Only models that are, or are not, deployed for inference","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"},"description":"Only models that are, or are not, deployed for inference"},"8119e39c-d680-4f66-aacf-cce79313e336":{"name":"type","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Type","description":"Only models whose type matches exactly, e.g. text-generation or embedding","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","description":"Only models whose type matches exactly, e.g. text-generation or embedding","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Only models whose type matches exactly, e.g. text-generation or embedding"},"523f02fa-2cd5-46ba-a742-a0e98d7a1e7e":{"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"},"7f4f834c-f507-485f-bee2-d8f9f48ba992":{"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":{"99a1e575-58b1-4a4f-8b31-285d7d298193":{"description":"Returns a list of all available base models that can be used for domain alignment.","content":{"application/json":{"schema":{"properties":{"models":{"items":{"properties":{"model_id":{"type":"string","title":"Model Id","description":"Unique identifier for the base model","examples":["Qwen/Qwen2.5-0.5B-Instruct"],"isRequired":true,"uniqueKey":"models.items.[INDEX].model_id","typeLabel":"string"},"model_name":{"type":"string","title":"Model Name","description":"Human-readable display name of the model","examples":["Qwen/Qwen2.5-0.5B-Instruct"],"isRequired":true,"uniqueKey":"models.items.[INDEX].model_name","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The Hugging Face pipeline_tag: text-generation or image-text-to-text","examples":["text-generation","image-text-to-text"],"isRequired":true,"uniqueKey":"models.items.[INDEX].type","typeLabel":"string"},"parameters":{"type":"string","title":"Parameters","description":"Model parameter count or configuration details","default":"N/A","examples":["0.5B"],"uniqueKey":"models.items.[INDEX].parameters","typeLabel":"string"},"alignment_ready":{"type":"boolean","title":"Alignment Ready","description":"Whether this model can be used as a base model for domain alignment","default":false,"uniqueKey":"models.items.[INDEX].alignment_ready","typeLabel":"boolean"},"inference_ready":{"type":"boolean","title":"Inference Ready","description":"Whether this model is deployed for chat, completions, embeddings or rerank","default":false,"uniqueKey":"models.items.[INDEX].inference_ready","typeLabel":"boolean"},"available_on_request":{"type":"boolean","title":"Available On Request","description":"Whether this model requires an access request before use","default":false,"uniqueKey":"models.items.[INDEX].available_on_request","typeLabel":"boolean"},"model_card":{"oneOf":[{"type":"string","title":"Model Card","description":"URL of the model card README on Hugging Face","example":"https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct/blob/main/README.md","uniqueKey":"models.items.[INDEX].model_card.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model Card","description":"URL of the model card README on Hugging Face","example":"https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct/blob/main/README.md","uniqueKey":"models.items.[INDEX].model_card.oneOf.1","typeLabel":"null"}],"uniqueKey":"models.items.[INDEX].model_card","typeLabel":"string | null"}},"type":"object","required":["model_id","model_name","type"],"title":"BaseModelSummary","uniqueKey":"models.items.[INDEX]","typeLabel":"BaseModelSummary · object"},"type":"array","title":"Models","description":"List of available base models","isRequired":true,"uniqueKey":"models","typeLabel":"BaseModelSummary · object[]"}},"type":"object","required":["models"],"title":"AvailableModels","examples":[{"models":[{"alignment_ready":true,"available_on_request":false,"model_id":"Qwen/Qwen2.5-0.5B-Instruct","model_name":"Qwen/Qwen2.5-0.5B-Instruct","parameters":"0.5B","type":"llm"},{"access_request_status":"PENDING","alignment_ready":false,"available_on_request":true,"model_id":"Qwen/Qwen2.5-1.5B-Instruct","model_name":"Llama V3p3 70b Instruct","parameters":"70B","type":"llm"}]}],"uniqueKey":"","typeLabel":"AvailableModels · object"},"examples":{"Example":{"title":"Example","value":{"models":[{"alignment_ready":true,"available_on_request":false,"model_id":"Qwen/Qwen2.5-0.5B-Instruct","model_name":"Qwen/Qwen2.5-0.5B-Instruct","parameters":"0.5B","type":"llm"},{"access_request_status":"PENDING","alignment_ready":false,"available_on_request":true,"model_id":"Qwen/Qwen2.5-1.5B-Instruct","model_name":"Llama V3p3 70b Instruct","parameters":"70B","type":"llm"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"15797a75-0299-4547-ad64-d003487f5f57":{"description":"Bad request - invalid query parameters","content":{"application/json":{"example":{"detail":"Bad request"},"examples":{"Example":{"title":"Example","value":{"detail":"Bad request"}}},"exampleType":"examples"}},"exampleType":"examples"},"e5c57de4-cbd8-4583-bdda-156f3579455b":{"description":"No base models found","content":{"application/json":{"example":{"detail":"No base models found"},"examples":{"Example":{"title":"Example","value":{"detail":"No base models found"}}},"exampleType":"examples"}},"exampleType":"examples"},"b5ccfc2e-63bc-4832-8e90-4ba4bd1ae441":{"description":"Validation error - invalid request parameters","content":{"application/json":{"example":{"detail":[{"loc":["header","Authorization"],"msg":"field required","type":"value_error.missing"}]},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["header","Authorization"],"msg":"field required","type":"value_error.missing"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"77c00d76-4533-46fa-928d-64e58fd97d0a":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"4e0c5fe7-c647-4e78-83c7-67b873654cb6":{"url":"https://api.nugen.in","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"https://api.nugen.in/openapi-public.json"},"subdomain":"courteasy","siteName":"Nugen API Reference Docs","title":"List Base Models - Nugen API Reference Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-03T01:16:25.448Z","originalFileLocation":"api-reference/models/list-base-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 the list of available base models. This endpoint returns all general-purpose base models available for use in chat completions, embeddings, and domain alignment workflows. Query Parameters: - alignment_ready (optional): true or false - inference_ready (optional): true or false - type (optional): text-generation or image-text-to-text - limit (optional): Number of models to return (1-100, default: 10) - offset (optional): Number of models to skip for pagination (default: 0) Returns: - models: List of base model objects, each containing: - model_id: Unique model identifier - model_name: Human-readable model name - parameters: Model parameter count - alignment_ready: Whether model can be used as a base for domain alignment - inference_ready: Whether model is deployed for chat, completions, embeddings or rerank - available_on_request: Whether this model requires an access request before use - 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 - model_card: URL of the model card README on Hugging Face Example Request: json GET /api/v3/models/base Headers: {\u0026quot;Authorization\u0026quot;: \u0026quot;Bearer \u0026quot;} Example Response: json { \u0026quot;models\u0026quot;: [ { \u0026quot;model_id\u0026quot;: \u0026quot;Qwen/Qwen2.5-0.5B-Instruct\u0026quot;, \u0026quot;model_name\u0026quot;: \u0026quot;Qwen/Qwen2.5-0.5B-Instruct\u0026quot;, \u0026quot;parameters\u0026quot;: \u0026quot;0.49B\u0026quot;, \u0026quot;alignment_ready\u0026quot;: true, \u0026quot;inference_ready\u0026quot;: true, \u0026quot;available_on_request\u0026quot;: false, \u0026quot;type\u0026quot;: \u0026quot;text-generation\u0026quot;, \u0026quot;model_card\u0026quot;: \u0026quot;https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct/blob/main/README.md\u0026quot; }, { \u0026quot;model_id\u0026quot;: \u0026quot;nomic-ai/nomic-embed-text-v1.5\u0026quot;, \u0026quot;model_name\u0026quot;: \u0026quot;nomic-ai/nomic-embed-text-v1.5\u0026quot;, \u0026quot;parameters\u0026quot;: \u0026quot;0.14B\u0026quot;, \u0026quot;alignment_ready\u0026quot;: false, \u0026quot;inference_ready\u0026quot;: true, \u0026quot;available_on_request\u0026quot;: false, \u0026quot;type\u0026quot;: \u0026quot;embedding\u0026quot;, \u0026quot;model_card\u0026quot;: \u0026quot;https://huggingface.co/nomic-ai/nomic-embed-text-v1.5/blob/main/README.md\u0026quot; } ] } Notes: - Base models are general-purpose starting points for domain alignment - These models can be used directly or as base models for domain alignment - Use /models/aligned to see your custom domain-aligned models - alignment_ready indicates if the model can be used as a base for domain 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 Base Models - Nugen API Reference Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve the list of available base models. This endpoint returns all general-purpose base models available for use in chat completions, embeddings, and domain alignment workflows. Query Parameters: - alignment_ready (optional): true or false - inference_ready (optional): true or false - type (optional): text-generation or image-text-to-text - limit (optional): Number of models to return (1-100, default: 10) - offset (optional): Number of models to skip for pagination (default: 0) Returns: - models: List of base model objects, each containing: - model_id: Unique model identifier - model_name: Human-readable model name - parameters: Model parameter count - alignment_ready: Whether model can be used as a base for domain alignment - inference_ready: Whether model is deployed for chat, completions, embeddings or rerank - available_on_request: Whether this model requires an access request before use - 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 - model_card: URL of the model card README on Hugging Face Example Request: json GET /api/v3/models/base Headers: {\u0026quot;Authorization\u0026quot;: \u0026quot;Bearer \u0026quot;} Example Response: json { \u0026quot;models\u0026quot;: [ { \u0026quot;model_id\u0026quot;: \u0026quot;Qwen/Qwen2.5-0.5B-Instruct\u0026quot;, \u0026quot;model_name\u0026quot;: \u0026quot;Qwen/Qwen2.5-0.5B-Instruct\u0026quot;, \u0026quot;parameters\u0026quot;: \u0026quot;0.49B\u0026quot;, \u0026quot;alignment_ready\u0026quot;: true, \u0026quot;inference_ready\u0026quot;: true, \u0026quot;available_on_request\u0026quot;: false, \u0026quot;type\u0026quot;: \u0026quot;text-generation\u0026quot;, \u0026quot;model_card\u0026quot;: \u0026quot;https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct/blob/main/README.md\u0026quot; }, { \u0026quot;model_id\u0026quot;: \u0026quot;nomic-ai/nomic-embed-text-v1.5\u0026quot;, \u0026quot;model_name\u0026quot;: \u0026quot;nomic-ai/nomic-embed-text-v1.5\u0026quot;, \u0026quot;parameters\u0026quot;: \u0026quot;0.14B\u0026quot;, \u0026quot;alignment_ready\u0026quot;: false, \u0026quot;inference_ready\u0026quot;: true, \u0026quot;available_on_request\u0026quot;: false, \u0026quot;type\u0026quot;: \u0026quot;embedding\u0026quot;, \u0026quot;model_card\u0026quot;: \u0026quot;https://huggingface.co/nomic-ai/nomic-embed-text-v1.5/blob/main/README.md\u0026quot; } ] } Notes: - Base models are general-purpose starting points for domain alignment - These models can be used directly or as base models for domain alignment - Use /models/aligned to see your custom domain-aligned models - alignment_ready indicates if the model can be used as a base for domain 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-base-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+Base+Models\u0026amp;description=Retrieve+the+list+of+available+base+models.%0A%0A%0AThis+endpoint+returns+all+general-purpose+base+models+available+for+use+in+chat+completions%2C+embeddings%2C+and+domai\u0026amp;theme=8395e2aaefdebbd3e68b298e\u0026amp;signature=329fe4c4c0c6e126c03788fa8631b12b787aa0e0c64a7ac367785a50430f407f\">\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 Base Models - Nugen API Reference Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve the list of available base models. This endpoint returns all general-purpose base models available for use in chat completions, embeddings, and domain alignment workflows. Query Parameters: - alignment_ready (optional): true or false - inference_ready (optional): true or false - type (optional): text-generation or image-text-to-text - limit (optional): Number of models to return (1-100, default: 10) - offset (optional): Number of models to skip for pagination (default: 0) Returns: - models: List of base model objects, each containing: - model_id: Unique model identifier - model_name: Human-readable model name - parameters: Model parameter count - alignment_ready: Whether model can be used as a base for domain alignment - inference_ready: Whether model is deployed for chat, completions, embeddings or rerank - available_on_request: Whether this model requires an access request before use - 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 - model_card: URL of the model card README on Hugging Face Example Request: json GET /api/v3/models/base Headers: {\u0026quot;Authorization\u0026quot;: \u0026quot;Bearer \u0026quot;} Example Response: json { \u0026quot;models\u0026quot;: [ { \u0026quot;model_id\u0026quot;: \u0026quot;Qwen/Qwen2.5-0.5B-Instruct\u0026quot;, \u0026quot;model_name\u0026quot;: \u0026quot;Qwen/Qwen2.5-0.5B-Instruct\u0026quot;, \u0026quot;parameters\u0026quot;: \u0026quot;0.49B\u0026quot;, \u0026quot;alignment_ready\u0026quot;: true, \u0026quot;inference_ready\u0026quot;: true, \u0026quot;available_on_request\u0026quot;: false, \u0026quot;type\u0026quot;: \u0026quot;text-generation\u0026quot;, \u0026quot;model_card\u0026quot;: \u0026quot;https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct/blob/main/README.md\u0026quot; }, { \u0026quot;model_id\u0026quot;: \u0026quot;nomic-ai/nomic-embed-text-v1.5\u0026quot;, \u0026quot;model_name\u0026quot;: \u0026quot;nomic-ai/nomic-embed-text-v1.5\u0026quot;, \u0026quot;parameters\u0026quot;: \u0026quot;0.14B\u0026quot;, \u0026quot;alignment_ready\u0026quot;: false, \u0026quot;inference_ready\u0026quot;: true, \u0026quot;available_on_request\u0026quot;: false, \u0026quot;type\u0026quot;: \u0026quot;embedding\u0026quot;, \u0026quot;model_card\u0026quot;: \u0026quot;https://huggingface.co/nomic-ai/nomic-embed-text-v1.5/blob/main/README.md\u0026quot; } ] } Notes: - Base models are general-purpose starting points for domain alignment - These models can be used directly or as base models for domain alignment - Use /models/aligned to see your custom domain-aligned models - alignment_ready indicates if the model can be used as a base for domain alignment\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://courteasy.mintlify.app/_mintlify/api/og/v2?division=Models\u0026amp;title=List+Base+Models\u0026amp;description=Retrieve+the+list+of+available+base+models.%0A%0A%0AThis+endpoint+returns+all+general-purpose+base+models+available+for+use+in+chat+completions%2C+embeddings%2C+and+domai\u0026amp;theme=8395e2aaefdebbd3e68b298e\u0026amp;signature=329fe4c4c0c6e126c03788fa8631b12b787aa0e0c64a7ac367785a50430f407f\">\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-base-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-base-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-base-models#webpage\",\"url\":\"https://docs.nugen.in/api-reference/models/list-base-models\",\"name\":\"List Base Models\",\"description\":\"Retrieve the list of available base models. This endpoint returns all general-purpose base models available for use in chat completions, embeddings, and domain alignment workflows. Query Parameters: - alignment_ready (optional): true or false - inference_ready (optional): true or false - type (optional): text-generation or image-text-to-text - limit (optional): Number of models to return (1-100, default: 10) - offset (optional): Number of models to skip for pagination (default: 0) Returns: - models: List of base model objects, each containing: - model_id: Unique model identifier - model_name: Human-readable model name - parameters: Model parameter count - alignment_ready: Whether model can be used as a base for domain alignment - inference_ready: Whether model is deployed for chat, completions, embeddings or rerank - available_on_request: Whether this model requires an access request before use - 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 - model_card: URL of the model card README on Hugging Face Example Request: json GET /api/v3/models/base Headers: {\\\"Authorization\\\": \\\"Bearer \\\"} Example Response: json { \\\"models\\\": [ { \\\"model_id\\\": \\\"Qwen/Qwen2.5-0.5B-Instruct\\\", \\\"model_name\\\": \\\"Qwen/Qwen2.5-0.5B-Instruct\\\", \\\"parameters\\\": \\\"0.49B\\\", \\\"alignment_ready\\\": true, \\\"inference_ready\\\": true, \\\"available_on_request\\\": false, \\\"type\\\": \\\"text-generation\\\", \\\"model_card\\\": \\\"https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct/blob/main/README.md\\\" }, { \\\"model_id\\\": \\\"nomic-ai/nomic-embed-text-v1.5\\\", \\\"model_name\\\": \\\"nomic-ai/nomic-embed-text-v1.5\\\", \\\"parameters\\\": \\\"0.14B\\\", \\\"alignment_ready\\\": false, \\\"inference_ready\\\": true, \\\"available_on_request\\\": false, \\\"type\\\": \\\"embedding\\\", \\\"model_card\\\": \\\"https://huggingface.co/nomic-ai/nomic-embed-text-v1.5/blob/main/README.md\\\" } ] } Notes: - Base models are general-purpose starting points for domain alignment - These models can be used directly or as base models for domain alignment - Use /models/aligned to see your custom domain-aligned models - alignment_ready indicates if the model can be used as a base for domain alignment\",\"dateModified\":\"2026-10-03T01:16:25.448Z\",\"isPartOf\":{\"@id\":\"https://docs.nugen.in#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nugen.in/api-reference/models/list-base-models#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nugen.in/api-reference/models/list-base-models#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Nugen API Reference Docs\",\"item\":\"https://docs.nugen.in\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Base Models\",\"item\":\"https://docs.nugen.in/api-reference/models/list-base-models\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nugen.in/api-reference/models/list-base-models#apireference\",\"headline\":\"List Base Models\",\"name\":\"List Base Models\",\"description\":\"Retrieve the list of available base models. This endpoint returns all general-purpose base models available for use in chat completions, embeddings, and domain alignment workflows. Query Parameters: - alignment_ready (optional): true or false - inference_ready (optional): true or false - type (optional): text-generation or image-text-to-text - limit (optional): Number of models to return (1-100, default: 10) - offset (optional): Number of models to skip for pagination (default: 0) Returns: - models: List of base model objects, each containing: - model_id: Unique model identifier - model_name: Human-readable model name - parameters: Model parameter count - alignment_ready: Whether model can be used as a base for domain alignment - inference_ready: Whether model is deployed for chat, completions, embeddings or rerank - available_on_request: Whether this model requires an access request before use - 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 - model_card: URL of the model card README on Hugging Face Example Request: json GET /api/v3/models/base Headers: {\\\"Authorization\\\": \\\"Bearer \\\"} Example Response: json { \\\"models\\\": [ { \\\"model_id\\\": \\\"Qwen/Qwen2.5-0.5B-Instruct\\\", \\\"model_name\\\": \\\"Qwen/Qwen2.5-0.5B-Instruct\\\", \\\"parameters\\\": \\\"0.49B\\\", \\\"alignment_ready\\\": true, \\\"inference_ready\\\": true, \\\"available_on_request\\\": false, \\\"type\\\": \\\"text-generation\\\", \\\"model_card\\\": \\\"https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct/blob/main/README.md\\\" }, { \\\"model_id\\\": \\\"nomic-ai/nomic-embed-text-v1.5\\\", \\\"model_name\\\": \\\"nomic-ai/nomic-embed-text-v1.5\\\", \\\"parameters\\\": \\\"0.14B\\\", \\\"alignment_ready\\\": false, \\\"inference_ready\\\": true, \\\"available_on_request\\\": false, \\\"type\\\": \\\"embedding\\\", \\\"model_card\\\": \\\"https://huggingface.co/nomic-ai/nomic-embed-text-v1.5/blob/main/README.md\\\" } ] } Notes: - Base models are general-purpose starting points for domain alignment - These models can be used directly or as base models for domain alignment - Use /models/aligned to see your custom domain-aligned models - alignment_ready indicates if the model can be used as a base for domain alignment\",\"url\":\"https://docs.nugen.in/api-reference/models/list-base-models\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nugen.in/api-reference/models/list-base-models#webpage\"},\"dateModified\":\"2026-10-03T01:16:25.448Z\",\"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":"Model Alignment","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/model-alignment/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/model-alignment/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/model-alignment/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/model-alignment/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/model-alignment/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/model-alignment/stop-alignment"},{"title":"Start Auto-Align","description":"Submit a target alignment score and let the system plan the run.\n\nThe system analyses your data, base model and prior train-time alignment history to build a\nmulti-phase alignment plan.\n\nPhases are sequenced and executed continuously. The system may apply\ngradient-free representation adjustments, supervised learning, reward-guided\noptimisation, or a combination, re-planning when the score trajectory demands\nit. Checkpoints are evaluated between phases, and the system revisits earlier\nphases if regressions surface.\n\nEvery parameter defaults to `auto`. You can override any of them to constrain\nthe search, and the system performs best when given room to explore.\n\n\n**Path Parameters:**\n\n- `alignment_id`: The alignment project to auto-align. Its base model, data and\n prior train-time alignment history warm-start the planning.\n\n\n**Request Body:**\n\n- `target_score` (required): Target quality on a 0-99 scale\n- `benchmark_id` (optional): Benchmark that measures the achieved score against\n the target. Defaults to the benchmark already on the project\n- `method`, `representations`, `sequencing` (optional): Constrain which\n optimisation families run and in what order\n- `max_compute_hours` (optional): Upper bound on GPU hours across all phases\n- `notify_on_phase_transition` (optional): Notify on each phase change\n- `config` (optional): Take control of any part of the run, for reinforcement\n learning or supervised (SFT) settings: loss, optimizer, LoRA adapter, reward,\n advantage, reference policy, environment, dataset, sampling, training,\n checkpointing, evaluation, rendering and logging. Pass only what you want to\n pin; anything omitted stays auto and redundant settings are discarded. Every\n field is listed in the `AutoAlignConfig` schema, with a full example\n\n\n**Returns:**\n\n- `auto_align_id`: Identifier of this request\n- `alignment_id`: The project it targets\n- `status`, `message`\n\n\n**Raises:**\n\n- `404`: If the alignment project is not found or does not belong to you\n\n\n**Notes:**\n\n- Auto-alignment is an Enterprise Edition capability. The request is recorded\n and our team follows up; raise a support ticket to enable it\n- Once enabled, poll `GET /alignment-projects/{alignment_id}/status` for\n progress, phase transitions and intermediate scores","deprecated":null,"version":null,"openapi":"https://api.nugen.in/openapi-public.json post /api/v3/alignment-projects/{alignment_id}/auto-align","href":"/api-reference/model-alignment/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","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"}]},{"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":"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":"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":"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"}]}]}]},"title":"List Base Models - Nugen API Reference Docs","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}