Get Alignment Status

curl --request GET \
  --url https://api.nugen.in/api/v3/alignment-project/status/{id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "PROCESSING",
  "data": {
    "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"
  },
  "start_time": "2024-01-15T10:30:00Z",
  "end_time": "2024-01-15T12:30:00Z",
  "gpu_training_completed": true
}

Alignment Project

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:

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

Example Response (Completed without evaluation):

{
    "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

GET

api

alignment-project

status

{id}

Get Alignment Status

curl --request GET \
  --url https://api.nugen.in/api/v3/alignment-project/status/{id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "PROCESSING",
  "data": {
    "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"
  },
  "start_time": "2024-01-15T10:30:00Z",
  "end_time": "2024-01-15T12:30:00Z",
  "gpu_training_completed": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

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.

status

enum<string>

required

Current status of the domain alignment project

Available options:

PROCESSING,

READY,

FAILED,

DEPLOYING,

EVALUATING,

UNDEPLOYED,

EVALUATED,

STOPPED

Example:

"PROCESSING"

data

AlignmentProject · object

Alignment project data if available

Show child attributes

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"
}

start_time

string<date-time> | null

Timestamp when the project started

Example:

"2024-01-15T10:30:00Z"

end_time

string<date-time> | null

Timestamp when the project completed or failed

Example:

"2024-01-15T12:30:00Z"

gpu_training_completed

boolean | null

Whether GPU training completed. True if done, False if failed/cancelled, null if still training.

Create Alignment Get Alignment Data