--- title: "Get Alignment Project" method: GET path: "/api/v3/alignment-projects/{alignment_id}" tags: ["Alignment Projects"] --- # Get Alignment Project `GET /api/v3/alignment-projects/{alignment_id}` ## Request - Base URL: `https://api.nugen.in` - URL: `https://api.nugen.in/api/v3/alignment-projects/{alignment_id}` - Auth: HTTP bearer Retrieve detailed information about a specific alignment project. This endpoint fetches comprehensive details about an alignment project including metadata, associated documents, train-time alignment progress, status, performance metrics, and evaluation information. **Path Parameters:** - `alignment_id`: Unique identifier of the alignment project **Returns:** - `alignment_id`: Alignment project identifier - `alignment_name`: Project name - `base_model_id`: Base model identifier used for alignment - `status`: Project status (`QUEUED`, `PROCESSING`, `READY`, `FAILED`, `STOPPED`) - `queue_position`, `stop_requested_at`, `early_deployable`: run qualifiers, same as the status endpoint - `created_at`: ISO timestamp when project was created - `completed_at` (optional): ISO timestamp when project completed - `updated_at`: Last update timestamp - `eta_seconds` (optional): not wired up yet, always null - `document_ids`: List of document IDs the synthetic training dataset was generated from - `document_count`: Number of documents used - `creator`: Username or ID of the project creator - `performance_metrics` (optional): Train-time alignment metrics (loss, accuracy, etc.) - `progress` (optional): Train-time alignment progress percentage (0-100) - `estimated_completion` (optional): Estimated completion time - `error` (optional): Error message if project failed - `degraded` (optional): True when the run reached READY but a stage failed on the way - `stage_failures` (optional): Stage failures on the way, if any - `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_01k4x9m2p7q3r8c1 Headers: {"Authorization": "Bearer "} ``` **Example Response (Completed):** ```json { "alignment_id":"alignment_01k4x9m2p7q3r8c1", "alignment_name": "Contract Risk Domain Alignment", "base_model_id": "Qwen/Qwen2.5-0.5B-Instruct", "status": "READY", "created_at": "2024-01-15T10:30:00Z", "completed_at": "2024-01-15T14:45:00Z", "document_ids": ["document_01k4x9m2p7q3r5s8", "document_01k4x9m2p7q3r5sc", "document_01k4x9m2p7q3r5sd"], "document_count": 3, "creator": "user-123", "performance_metrics": { "final_loss": 0.15, "accuracy": 0.92, "perplexity": 2.3 }, "evaluation_id": "evaluation_01k4x9m2p7q3r7b1", "model_id": "alignment_01k4x9m2p7q3r8c1-deployed" } ``` **Example Response (In Progress):** ```json { "alignment_id":"alignment_01k4x9m2p7q3r8c2", "alignment_name": "Technical Documentation Alignment", "base_model_id": "Qwen/Qwen2.5-0.5B-Instruct", "status": "PROCESSING", "created_at": "2024-01-16T09:00:00Z", "document_ids": ["document_01k4x9m2p7q3r5sh", "document_01k4x9m2p7q3r5sj"], "document_count": 2, "creator": "user-123", "progress": 45, "estimated_completion": "2024-01-16T11:30:00Z" } ``` **Notes:** - Returns full project details including train-time alignment progress and performance - `model_id` is only available for projects that have been deployed for evaluation - `evaluation_id` is the evaluation created from `benchmark_id`, present once train-time alignment finishes - `performance_metrics` are populated after train-time alignment completes - `progress` and `estimated_completion` are available during train-time alignment - `error` field contains failure details if status is `FAILED` ## Path parameters - `alignment_id` string, required ## Response `200` Returns detailed information about a specific alignment project, including metadata, associated documents, train-time alignment progress, status, performance metrics, and evaluation information - AlignmentProjectGetResponse: One alignment project's full record: everything on its status and list rows, plus configuration, documents and metrics found nowhere else. - `alignment_id` string, required: Unique identifier for the alignment project - `alignment_name` string, required: Human-readable name for the alignment project - `base_model_id` string, required: ID of the base model used for train-time alignment - `status` 'QUEUED' | 'PROCESSING' | 'READY' | 'FAILED' | 'STOPPED', required: Lifecycle status of a resource that runs asynchronously. Stored as is and returned as is, with no translation in between. - `QUEUED`: accepted and waiting for its workflow to start - `PROCESSING`: running - `READY`: finished successfully - `FAILED`: failed at any stage - `STOPPED`: stopped by the user before completion - `queue_position` integer, nullable: Place in the queue while status is QUEUED, 1 meaning next to start. Null once execution has begun. - `stop_requested_at` string, nullable: Set once a stop was requested; the run ends STOPPED. - `early_deployable` boolean: True once train-time alignment has written a checkpoint, so POST /models/{model_id}/deployment?early=true will succeed. Only meaningful while status is still PROCESSING; false once train-time alignment has finished, since a normal deploy applies then. - `created_at` string, date-time, required: ISO 8601 timestamp when the project was created - `completed_at` string, nullable: ISO 8601 timestamp when the project completed (null if still in progress or failed) - `updated_at` string, nullable: Last update timestamp. - `eta_seconds` integer, nullable: Estimated time remaining in seconds. Not wired up yet, always null. - `document_ids` string[], required: List of document IDs used for train-time alignment - `document_count` integer, required: Total number of documents used for train-time alignment - `creator` string, required: Email/username of the user who created this project - `performance_metrics` AlignmentProjectPerformanceMetrics: Model performance measured before and after alignment. - `accuracy_before` number, required: Accuracy before alignment - `accuracy_after` number, required: Accuracy after alignment - `uncertainty_before` number, required: Uncertainty before alignment - `uncertainty_after` number, required: Uncertainty after alignment - `domain_violations_before` integer, required: Domain violations before alignment - `domain_violations_after` integer, required: Domain violations after alignment - `progress` integer, nullable: Train-time alignment progress percentage (0-100). Null if not started or completed. - `estimated_completion` string, nullable: Estimated completion time (ISO 8601 timestamp). Null if not available or completed. - `error` string, nullable: Error message if the alignment project failed. Null if no error. - `degraded` boolean, nullable: True when the run reached its end state but a stage failed on the way. - `stage_failures` unknown[], nullable: Stage failures on the way; each entry carries stage, status and failed_reason. - unknown - `evaluation_id` string, nullable: Latest evaluation ID for this alignment - `model_id` string, nullable: Deployed model ID if the aligned model was automatically deployed for evaluation - `gpu_training_completed` boolean, nullable: Whether train-time alignment completed successfully. True if completed, False if failed/cancelled, null if still in progress. - `is_adapter_available` boolean, nullable: True when an adapter checkpoint is live on the inference server and the model is ready for inference. Use model_id from this response to call the inference endpoint. ## Other responses - `401`: Invalid API key - `403`: Authorization header missing or not a Bearer token - `404`: Resource not found - `422`: Validation Error --- [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)