---
title: "List Aligned Models"
method: GET
path: "/api/v3/models/aligned"
tags: ["Models"]
---

# List Aligned Models

`GET /api/v3/models/aligned`

## Request

- Base URL: `https://api.nugen.in`
- URL: `https://api.nugen.in/api/v3/models/aligned`
- Auth: HTTP bearer

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 <api_key>"}
```


**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

## Query parameters

- `deployment_status` 'UNDEPLOYED' | 'DEPLOYING' | 'DEPLOYED' | 'UNDEPLOYING': 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.
- `base_model_id` string, nullable: Only models aligned from this base model, by exact id
- `limit` integer: Number of models to return
- `offset` integer: Number of models to skip

## Response `200`

Returns a list of all domain-aligned models created by the authenticated user.

- ModelListAlignedResponse: The caller's aligned models.
  - `domain_aligned_models` ModelListAlignedItem[], required: One summary row per aligned model. Performance metrics and evaluation data are served by GET /models/{model_id}.
    - `model_id` string, required: Unique identifier for the aligned model
    - `model_name` string, required: Human-readable name assigned to the aligned model
    - `deployment_status` 'UNDEPLOYED' | 'DEPLOYING' | 'DEPLOYED' | 'UNDEPLOYING', required: 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.
    - `base_model_id` string, required: ID of the base model used for domain alignment
    - `alignment_id` string, nullable: The alignment project that produced this model; each alignment produces at most one model
    - `created_at` string, date-time, required: Timestamp when the model was created

## Other responses

- `400`: Bad request - invalid query parameters
- `401`: Invalid API key
- `403`: Authorization header missing or not a Bearer token
- `404`: No aligned models found for the authenticated user
- `422`: Validation error - invalid request parameters

---

[API](https://skmtc.dev/nugen/apis/nugen-intelligence-api.md) - [All operations](https://skmtc.dev/nugen/apis/nugen-intelligence-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nugen/apis/nugen-intelligence-api/revisions/62baa7960a4a?raw)