> ## 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 Alignment Status

> Get the status of an alignment task that was created using create endpoint.


This endpoint retrieves the current status and progress of a domain alignment workflow. Use this to track the alignment process and retrieve results once completed.


**Path Parameters:**

- `id`: Unique alignment identifier (returned from create endpoint)


**Returns:**

- `status`: Workflow status (PROCESSING, READY or FAILED)
- `data`: Alignment details and results (if completed)
- `start_time`: Timestamp when workflow started
- `end_time`: Timestamp when workflow completed (null if still running)

**Raises:**
- `404`: If alignment workflow not found or doesn't belong to user

**Example Request:**
```json
GET /api/v3/alignment/status/alignment-xyz789
Headers: {"Authorization": "Bearer <api_key>"}
```

**Example Response (Completed without evaluation):**

```json
{
    "id":"alignment_01KJY6S8N9R8CNX",
    "name":"TEST_ALIGNMENT_WITH_BENCHMARK",
    "base_model":"qwen-v2p5-0p5b-instruct",
    "status":"PROCESSING",
    "created_date":"2026-03-05 05:16:01.986524",
    "completed_date":null,
    "documents":["doc_01KJW9M0QC2YY8R"],
    "document_count":1,
    "creator":"user@gmail.com",
    "performance_metrics":null,
    "progress":0,
    "estimated_completion":null,
    "error":null,
    "evaluation_id":null,
    "model_id":"model_test_alignment_with_benchmark_alignment_01kjy6s8n9r8cnx"
},
```
**Notes:**
- Use the model_id field in the response to identify the aligned model for deployment. 
- Use the deploy endpoint to deploy the aligned model and then perfrom evaluation or inference with an aligned model 
- Status : PROCESSING (alignment still in progress), READY or FAILED
- `aligned_model_id` is only available when status is READY
- Evaluation results are included if benchmark was specified during creation



## OpenAPI

````yaml https://api.nugen.in/openapi-public.json get /api/v3/alignment-project/status/{id}
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/alignment-project/status/{id}:
    get:
      tags:
        - Alignment Project
      summary: Get Alignment Status
      description: >-
        Get the status of an alignment task that was created using create
        endpoint.



        This endpoint retrieves the current status and progress of a domain
        alignment workflow. Use this to track the alignment process and retrieve
        results once completed.



        **Path Parameters:**


        - `id`: Unique alignment identifier (returned from create endpoint)



        **Returns:**


        - `status`: Workflow status (PROCESSING, READY or FAILED)

        - `data`: Alignment details and results (if completed)

        - `start_time`: Timestamp when workflow started

        - `end_time`: Timestamp when workflow completed (null if still running)


        **Raises:**

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


        **Example Request:**

        ```json

        GET /api/v3/alignment/status/alignment-xyz789

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

        ```


        **Example Response (Completed without evaluation):**


        ```json

        {
            "id":"alignment_01KJY6S8N9R8CNX",
            "name":"TEST_ALIGNMENT_WITH_BENCHMARK",
            "base_model":"qwen-v2p5-0p5b-instruct",
            "status":"PROCESSING",
            "created_date":"2026-03-05 05:16:01.986524",
            "completed_date":null,
            "documents":["doc_01KJW9M0QC2YY8R"],
            "document_count":1,
            "creator":"user@gmail.com",
            "performance_metrics":null,
            "progress":0,
            "estimated_completion":null,
            "error":null,
            "evaluation_id":null,
            "model_id":"model_test_alignment_with_benchmark_alignment_01kjy6s8n9r8cnx"
        },

        ```

        **Notes:**

        - Use the model_id field in the response to identify the aligned model
        for deployment. 

        - Use the deploy endpoint to deploy the aligned model and then perfrom
        evaluation or inference with an aligned model 

        - Status : PROCESSING (alignment still in progress), READY or FAILED

        - `aligned_model_id` is only available when status is READY

        - Evaluation results are included if benchmark was specified during
        creation
      operationId: alignment_status_endpoint
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            title: Id
      responses:
        '200':
          description: >-
            Returns the status of an alignment task that was created using
            create endpoint. This endpoint retrieves the current status and
            progress of a domain alignment workflow, allowing users to track the
            alignment process and retrieve results once completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAlignmentProjectStatus'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    DomainAlignmentProjectStatus:
      properties:
        status:
          $ref: '#/components/schemas/TaskStatus'
          description: Current status of the domain alignment project
          example: PROCESSING
        data:
          anyOf:
            - $ref: '#/components/schemas/AlignmentProject'
            - type: 'null'
          description: Alignment project data if available
        start_time:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Start Time
          description: Timestamp when the project started
          example: '2024-01-15T10:30:00Z'
        end_time:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: End Time
          description: Timestamp when the project completed or failed
          example: '2024-01-15T12:30:00Z'
        gpu_training_completed:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Gpu Training Completed
          description: >-
            Whether GPU training completed. True if done, False if
            failed/cancelled, null if still training.
      type: object
      required:
        - status
      title: DomainAlignmentProjectStatus
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TaskStatus:
      type: string
      enum:
        - PROCESSING
        - READY
        - FAILED
        - DEPLOYING
        - EVALUATING
        - UNDEPLOYED
        - EVALUATED
        - STOPPED
      title: TaskStatus
    AlignmentProject:
      properties:
        alignment_id:
          type: string
          title: Alignment Id
          description: Unique identifier for the alignment project
          example:
            - alignment-abc123
            - alignment-xyz789
        alignment_name:
          type: string
          title: Alignment Name
          description: Human-readable name for the alignment project
          example:
            - Customer Support Model
            - Legal Document Assistant
            - Medical Q&A Bot
        base_model:
          type: string
          title: Base Model
          description: ID of the base model used for alignment training
          example:
            - nugen-flash-instruct
            - model-20240229
        status:
          $ref: '#/components/schemas/TaskStatus'
          description: Current status of the alignment project (PROCESSING, READY, FAILED)
        created_date:
          type: string
          title: Created Date
          description: ISO 8601 timestamp when the project was created
          example:
            - '2024-01-15T10:30:00Z'
            - '2024-02-01T09:15:00Z'
        completed_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Completed Date
          description: >-
            ISO 8601 timestamp when the project completed (null if still in
            progress or failed)
          example:
            - '2024-01-15T12:45:00Z'
            - null
        document_ids:
          items:
            type: string
          type: array
          title: Document Ids
          description: List of document IDs used for alignment training
          example:
            - - doc-abc123
              - doc-def456
            - - doc-xyz789
        document_count:
          type: integer
          minimum: 0
          title: Document Count
          description: Total number of documents used for training
          example:
            - 5
            - 12
            - 3
        creator:
          type: string
          title: Creator
          description: Email/username of the user who created this project
          example:
            - user@example.com
            - admin@company.com
        performance_metrics:
          anyOf:
            - $ref: '#/components/schemas/AlignmentProjectPerformanceMetrics'
            - type: 'null'
          description: >-
            Performance comparison metrics showing before/after alignment
            improvements (available after evaluation)
        progress:
          anyOf:
            - type: integer
              maximum: 100
              minimum: 0
            - type: 'null'
          title: Progress
          description: >-
            Training progress percentage (0-100). Null if not started or
            completed.
          example:
            - 0
            - 45
            - 100
            - null
        estimated_completion:
          anyOf:
            - type: string
            - type: 'null'
          title: Estimated Completion
          description: >-
            Estimated completion time (ISO 8601 timestamp). Null if not
            available or completed.
          example:
            - '2024-01-15T14:00:00Z'
            - null
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: Error message if the alignment project failed. Null if no error.
          example:
            - 'Training failed: insufficient data'
            - Out of memory error
            - null
        evaluation_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Evaluation Id
          description: >-
            Auto-evaluation ID if automatic evaluation was triggered after
            alignment completion
          example:
            - eval-abc123
            - null
        model_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Model Id
          description: >-
            Deployed model ID if the aligned model was automatically deployed
            for evaluation
          example:
            - alignment-abc123-deployed
            - null
        gpu_training_completed:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Gpu Training Completed
          description: >-
            Whether GPU training completed successfully. True if completed,
            False if failed/cancelled, null if still in progress.
          example:
            - true
            - false
            - null
      type: object
      required:
        - alignment_id
        - alignment_name
        - base_model
        - status
        - created_date
        - document_ids
        - document_count
        - creator
      title: AlignmentProject
      example:
        alignment_id: alignment-abc123
        alignment_name: Customer Support Model
        base_model: nugen-flash-instruct
        completed_date: '2024-01-15T12:45:00Z'
        created_date: '2024-01-15T10:30:00Z'
        creator: user@example.com
        document_count: 3
        document_ids:
          - doc-abc123
          - doc-def456
          - doc-ghi789
        evaluation_id: eval-xyz789
        model_id: alignment-abc123-deployed
        performance_metrics:
          accuracy_after: 0.92
          accuracy_before: 0.75
          domain_violations_after: 2
          domain_violations_before: 12
          uncertainty_after: 0.15
          uncertainty_before: 0.35
        progress: 100
        status: READY
    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
    AlignmentProjectPerformanceMetrics:
      properties:
        accuracy_before:
          type: number
          title: Accuracy Before
        accuracy_after:
          type: number
          title: Accuracy After
        uncertainty_before:
          type: number
          title: Uncertainty Before
        uncertainty_after:
          type: number
          title: Uncertainty After
        domain_violations_before:
          type: integer
          title: Domain Violations Before
        domain_violations_after:
          type: integer
          title: Domain Violations After
      type: object
      required:
        - accuracy_before
        - accuracy_after
        - uncertainty_before
        - uncertainty_after
        - domain_violations_before
        - domain_violations_after
      title: AlignmentProjectPerformanceMetrics
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````