---
title: "Get Deployment Status"
method: GET
path: "/api/v3/models/{model_id}/deployment/status"
tags: ["Models"]
---

# Get Deployment Status

`GET /api/v3/models/{model_id}/deployment/status`

## Request

- Base URL: `https://api.nugen.in`
- URL: `https://api.nugen.in/api/v3/models/{model_id}/deployment/status`
- Auth: HTTP bearer

Check the deployment status of an aligned model.


This endpoint retrieves the current deployment status of a model, including progress and completion information.


**Path Parameters:**

- `model_id`: Unique identifier of the model to check deployment status for


**Returns:**

- `model_id`: The model identifier
- `status`: Deployment status
  - `UNDEPLOYED`: not serving, and deployable
  - `DEPLOYING`: a deploy is in flight
  - `DEPLOYED`: serving inference
  - `UNDEPLOYING`: an undeploy is in flight
- `error`: why the last attempt failed, null when it succeeded
- `created_at`, `completed_at`, `updated_at`: timestamps
- `progress`, `eta_seconds`: not wired up yet, always null

A failed attempt settles back to the state it came from, so read `error` alongside `status`: UNDEPLOYED with an error means the deploy failed, DEPLOYED with an error means the undeploy failed.


**Raises:**

- `404`: If model not found or doesn't belong to user


**Example Request:**

```json
GET /api/v3/models/alignment_01k4x9m2p7q3r8c1/deployment/status
Headers: {"Authorization": "Bearer <api_key>"}
```


**Example Response (deploy in flight):**

```json
{
  "model_id": "model_01kmqm4nrn9fw6r",
  "status": "DEPLOYING",
  "error": null,
  "created_at": "2024-02-24T10:00:00Z",
  "completed_at": null,
  "updated_at": "2024-02-24T10:00:00Z",
  "progress": null,
  "eta_seconds": null
}
```


**Example Response (serving):**

```json
{
  "model_id": "model_01kmqm4nrn9fw6r",
  "status": "DEPLOYED",
  "error": null,
  "created_at": "2024-02-24T10:00:00Z",
  "completed_at": "2024-02-24T10:05:00Z",
  "updated_at": "2024-02-24T10:05:00Z",
  "progress": null,
  "eta_seconds": null
}
```


**Example Response (deploy failed):**

```json
{
  "model_id": "model_01kmqm4nrn9fw6r",
  "status": "UNDEPLOYED",
  "error": "provider rejected the adapter",
  "created_at": "2024-02-24T10:00:00Z",
  "completed_at": "2024-02-24T10:02:30Z",
  "updated_at": "2024-02-24T10:02:30Z",
  "progress": null,
  "eta_seconds": null
}
```


**Notes:**

- Poll this endpoint to track deployment progress
- Only `DEPLOYED` serves inference; every other status returns 400 from the inference endpoints
- A deploy that fails settles at `UNDEPLOYED` and an undeploy that fails settles at `DEPLOYED`, both with the reason in `error`

## Path parameters

- `model_id` string, required

## Response `200`

Returns the current deployment status of an aligned model.

- ModelDeploymentStatusResponse: Deployment state of one aligned model.
  - `model_id` string, required: model ID that you want to deploy
  - `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.
  - `error` string, nullable: Why the last attempt failed, null when it succeeded. Read with status: UNDEPLOYED with an error means the deploy failed, DEPLOYED with an error means the undeploy failed.
  - `created_at` string, date-time, nullable: Timestamp when this status check ran
  - `completed_at` string, date-time, nullable: Timestamp when the deployment operation completed; null while still running
  - `updated_at` string, date-time, nullable: Timestamp of the last status change
  - `progress` number, nullable: Completion progress, 0.0 to 100.0. Not wired up yet, always null.
  - `eta_seconds` integer, nullable: Estimated time remaining in seconds. Not wired up yet, always null.

## Other responses

- `400`: Bad request - invalid model ID or parameters
- `401`: Invalid API key
- `403`: Authorization header missing or not a Bearer token
- `404`: Model not found
- `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)