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 (pending, completed or failed)data: Alignment details and results (if completed)start_time: Timestamp when workflow startedend_time: Timestamp when workflow completed (null if still running)
Raises:
404: If alignment workflow not found or doesn’t belong to user
Example Request:
GET /api/v3/alignment/status/alignment-xyz789
Headers: {"Authorization": "Bearer <api_key>"}
Example Response (Completed):
{
"status": "c",
"data": {
"aligned_model_id": "alignment-xyz789",
"base_model": "nugen-flash-instruct",
"name": "Customer Support Domain Alignment",
"evaluation_results": {
"accuracy": 0.92,
"total_questions": 50
}
},
"start_time": "2024-01-15T10:30:00Z",
"end_time": "2024-01-15T14:45:00Z"
}
Notes:
- Status : pending (alignment still in progress), completed or failed
aligned_model_idis only available when status is completed- Evaluation results are included if benchmark was specified during creation
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
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.
Current status of the domain alignment project
pending, completed, deploying, evaluating, undeployed, evaluated, failed "pending"
Alignment project data if available
{
"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,
"documents": ["doc-abc123", "doc-def456", "doc-ghi789"],
"evaluation_id": "eval-xyz789",
"id": "alignment-abc123",
"model_id": "alignment-abc123-deployed",
"name": "Customer Support Model",
"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": "COMPLETED"
}Timestamp when the project started
"2024-01-15T10:30:00Z"
Timestamp when the project completed or failed
"2024-01-15T12:30:00Z"