> ## 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 Project > 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:** - `alignment_id`: Alignment project identifier - `alignment_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 - `document_ids`: 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 "} ``` **Example Response (Completed):** ```json { "alignment_id":"alignment-xyz789", "alignment_name": "Customer Support Domain Alignment", "base_model": "qwen-v2p5-0p5b-instruct", "status": "READY", "created_date": "2024-01-15T10:30:00Z", "completed_date": "2024-01-15T14:45:00Z", "document_ids": ["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 { "alignment_id":"alignment-abc456", "alignment_name": "Technical Documentation Alignment", "base_model": "qwen-v2p5-0p5b-instruct", "status": "PROCESSING", "created_date": "2024-01-16T09:00:00Z", "document_ids": ["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-projects/{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-projects/{id}: get: tags: - General summary: Get Alignment Project 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:** - `alignment_id`: Alignment project identifier - `alignment_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 - `document_ids`: 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 "} ``` **Example Response (Completed):** ```json { "alignment_id":"alignment-xyz789", "alignment_name": "Customer Support Domain Alignment", "base_model": "qwen-v2p5-0p5b-instruct", "status": "READY", "created_date": "2024-01-15T10:30:00Z", "completed_date": "2024-01-15T14:45:00Z", "document_ids": ["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 { "alignment_id":"alignment-abc456", "alignment_name": "Technical Documentation Alignment", "base_model": "qwen-v2p5-0p5b-instruct", "status": "PROCESSING", "created_date": "2024-01-16T09:00:00Z", "document_ids": ["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: alignment_projects_get parameters: - name: id in: path required: true schema: type: string title: 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 ````