> ## 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 Data

> Retrieve detailed information about a specific alignment project.


This endpoint fetches comprehensive details about an alignment project including metadata, associated documents, training progress, status, performance metrics, and evaluation information.


**Path Parameters:**

- `id`: Unique identifier of the alignment project


**Returns:**

- `id`: Alignment project identifier
- `name`: Project name
- `base_model`: Base model identifier used for alignment
- `status`: Project status (`PENDING`, `COMPLETED`, `FAILED`)
- `created_date`: ISO timestamp when project was created
- `completed_date` (optional): ISO timestamp when project completed
- `documents`: List of document IDs used for training
- `document_count`: Number of documents used
- `creator`: Username or ID of the project creator
- `performance_metrics` (optional): Training performance metrics (loss, accuracy, etc.)
- `progress` (optional): Training progress percentage (0-100)
- `estimated_completion` (optional): Estimated completion time
- `error` (optional): Error message if project failed
- `evaluation_id` (optional): Auto-evaluation ID if triggered
- `model_id` (optional): Deployed model ID for evaluation


**Raises:**

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


**Example Request:**

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


**Example Response (Completed):**

```json
{
  "id": "alignment-xyz789",
  "name": "Customer Support Domain Alignment",
  "base_model": "nugen-flash-instruct",
  "status": "READY",
  "created_date": "2024-01-15T10:30:00Z",
  "completed_date": "2024-01-15T14:45:00Z",
  "documents": ["doc-abc123", "doc-xyz456", "doc-def789"],
  "document_count": 3,
  "creator": "user-123",
  "performance_metrics": {
    "final_loss": 0.15,
    "accuracy": 0.92,
    "perplexity": 2.3
  },
  "evaluation_id": "eval-def456",
  "model_id": "alignment-xyz789-deployed"
}
```


**Example Response (In Progress):**

```json
{
  "id": "alignment-abc456",
  "name": "Technical Documentation Alignment",
  "base_model": "nugen-flash-instruct",
  "status": "PROCESSING",
  "created_date": "2024-01-16T09:00:00Z",
  "documents": ["doc-111", "doc-222"],
  "document_count": 2,
  "creator": "user-123",
  "progress": 45,
  "estimated_completion": "2024-01-16T11:30:00Z"
}
```


**Notes:**

- Returns full project details including training progress and performance
- `model_id` is only available for projects that have been deployed for evaluation
- `evaluation_id` is only present if auto-evaluation was triggered
- `performance_metrics` are populated after training completes
- `progress` and `estimated_completion` are available during training
- `error` field contains failure details if status is `FAILED`



## OpenAPI

````yaml https://api.nugen.in/openapi-public.json get /api/v3/alignment-project/{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/{id}:
    get:
      tags:
        - Alignment Project
      summary: Get Alignment Data
      description: >-
        Retrieve detailed information about a specific alignment project.



        This endpoint fetches comprehensive details about an alignment project
        including metadata, associated documents, training progress, status,
        performance metrics, and evaluation information.



        **Path Parameters:**


        - `id`: Unique identifier of the alignment project



        **Returns:**


        - `id`: Alignment project identifier

        - `name`: Project name

        - `base_model`: Base model identifier used for alignment

        - `status`: Project status (`PENDING`, `COMPLETED`, `FAILED`)

        - `created_date`: ISO timestamp when project was created

        - `completed_date` (optional): ISO timestamp when project completed

        - `documents`: List of document IDs used for training

        - `document_count`: Number of documents used

        - `creator`: Username or ID of the project creator

        - `performance_metrics` (optional): Training performance metrics (loss,
        accuracy, etc.)

        - `progress` (optional): Training progress percentage (0-100)

        - `estimated_completion` (optional): Estimated completion time

        - `error` (optional): Error message if project failed

        - `evaluation_id` (optional): Auto-evaluation ID if triggered

        - `model_id` (optional): Deployed model ID for evaluation



        **Raises:**


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



        **Example Request:**


        ```json

        GET /api/v3/alignment/alignment-xyz789

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

        ```



        **Example Response (Completed):**


        ```json

        {
          "id": "alignment-xyz789",
          "name": "Customer Support Domain Alignment",
          "base_model": "nugen-flash-instruct",
          "status": "READY",
          "created_date": "2024-01-15T10:30:00Z",
          "completed_date": "2024-01-15T14:45:00Z",
          "documents": ["doc-abc123", "doc-xyz456", "doc-def789"],
          "document_count": 3,
          "creator": "user-123",
          "performance_metrics": {
            "final_loss": 0.15,
            "accuracy": 0.92,
            "perplexity": 2.3
          },
          "evaluation_id": "eval-def456",
          "model_id": "alignment-xyz789-deployed"
        }

        ```



        **Example Response (In Progress):**


        ```json

        {
          "id": "alignment-abc456",
          "name": "Technical Documentation Alignment",
          "base_model": "nugen-flash-instruct",
          "status": "PROCESSING",
          "created_date": "2024-01-16T09:00:00Z",
          "documents": ["doc-111", "doc-222"],
          "document_count": 2,
          "creator": "user-123",
          "progress": 45,
          "estimated_completion": "2024-01-16T11:30:00Z"
        }

        ```



        **Notes:**


        - Returns full project details including training progress and
        performance

        - `model_id` is only available for projects that have been deployed for
        evaluation

        - `evaluation_id` is only present if auto-evaluation was triggered

        - `performance_metrics` are populated after training completes

        - `progress` and `estimated_completion` are available during training

        - `error` field contains failure details if status is `FAILED`
      operationId: get_alignment_project_by_id
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            title: Id
      responses:
        '200':
          description: >-
            Returns detailed information about a specific alignment project,
            including metadata, associated documents, training progress, status,
            performance metrics, and evaluation information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlignmentProject'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    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
    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
    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
    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

````