> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nugen.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Model Deployment Status

> 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
  - `PROCESSING`: Deployment in progress
  - `READY`: Successfully deployed
  - `FAILED`: Deployment failed
- `result`: Task result details (if completed)
- `start_time`: Timestamp when deployment started
- `end_time`: Timestamp when deployment completed (null if still pending)


**Raises:**

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


**Example Request:**

```json
GET /api/v3/models/deploy-model/alignment-xyz789/status
Headers: {"Authorization": "Bearer <api_key>"}
```


**Example Response (Pending):**

```json
{
  "model_id": "alignment-xyz789",
  "status": "PROCESSING",
  "result": null,
  "start_time": "2024-02-24T10:00:00Z",
  "end_time": null
}
```


**Example Response (Completed):**

```json
{
  "model_id": "aligned-model-01kmqm4nrn9fw6r",
  "status": "READY",
  "result": {
    "deployment_id": "deploy-abc123",
    "endpoint_url": "https://api.example.com/v1/models/alignment-xyz789"
  },
  "start_time": "2024-02-24T10:00:00Z",
  "end_time": "2024-02-24T10:05:00Z"
}
```


**Example Response (Failed):**

```json
{
  "model_id": "aligned-model-01kmqm4nrn9fw6r",
  "status": "FAILED",
  "result": {
    "error": "Deployment failed due to insufficient resources"
  },
  "start_time": "2024-02-24T10:00:00Z",
  "end_time": "2024-02-24T10:02:30Z"
}
```


**Notes:**

- Poll this endpoint to track deployment progress
- Status `READY` means the undeploy or deploy operation finished
- Once completed, use `/models/aligned` to get the inference endpoint URL



## OpenAPI

````yaml https://api.nugen.in/openapi-public.json get /api/v3/models/{model_id}/deployment/status
openapi: 3.1.0
info:
  title: Nugen Intelligence API
  description: 'Nugen Intelligence : Powering Specialized Intelligence At Scale'
  version: 25.4.20
servers: []
security: []
paths:
  /api/v3/models/{model_id}/deployment/status:
    get:
      tags:
        - General
      summary: Get Model Deployment Status
      description: >-
        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
          - `PROCESSING`: Deployment in progress
          - `READY`: Successfully deployed
          - `FAILED`: Deployment failed
        - `result`: Task result details (if completed)

        - `start_time`: Timestamp when deployment started

        - `end_time`: Timestamp when deployment completed (null if still
        pending)



        **Raises:**


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



        **Example Request:**


        ```json

        GET /api/v3/models/deploy-model/alignment-xyz789/status

        Headers: {"Authorization": "Bearer <api_key>"}

        ```



        **Example Response (Pending):**


        ```json

        {
          "model_id": "alignment-xyz789",
          "status": "PROCESSING",
          "result": null,
          "start_time": "2024-02-24T10:00:00Z",
          "end_time": null
        }

        ```



        **Example Response (Completed):**


        ```json

        {
          "model_id": "aligned-model-01kmqm4nrn9fw6r",
          "status": "READY",
          "result": {
            "deployment_id": "deploy-abc123",
            "endpoint_url": "https://api.example.com/v1/models/alignment-xyz789"
          },
          "start_time": "2024-02-24T10:00:00Z",
          "end_time": "2024-02-24T10:05:00Z"
        }

        ```



        **Example Response (Failed):**


        ```json

        {
          "model_id": "aligned-model-01kmqm4nrn9fw6r",
          "status": "FAILED",
          "result": {
            "error": "Deployment failed due to insufficient resources"
          },
          "start_time": "2024-02-24T10:00:00Z",
          "end_time": "2024-02-24T10:02:30Z"
        }

        ```



        **Notes:**


        - Poll this endpoint to track deployment progress

        - Status `READY` means the undeploy or deploy operation finished

        - Once completed, use `/models/aligned` to get the inference endpoint
        URL
      operationId: models_deployment_status
      parameters:
        - name: model_id
          in: path
          required: true
          schema:
            type: string
            title: Model Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````