List Alignment Projects

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

{
  "alignment_projects": [
    {
      "id": "<string>",
      "name": "<string>",
      "base_model": "<string>",
      "status": "pending",
      "created_date": "<string>",
      "documents": [
        "<string>"
      ],
      "document_count": 123,
      "creator": "<string>",
      "completed_date": "<string>",
      "performance_metrics": {
        "accuracy_before": 123,
        "accuracy_after": 123,
        "uncertainty_before": 123,
        "uncertainty_after": 123,
        "domain_violations_before": 123,
        "domain_violations_after": 123
      },
      "progress": 123,
      "estimated_completion": "<string>",
      "error": "<string>",
      "evaluation_id": "<string>",
      "model_id": "<string>"
    }
  ]
}

Alignment Project

List Alignment Projects

Retrieve all alignment projects for the authenticated user.

This endpoint returns a comprehensive list of all domain alignment projects created by the user, including project metadata, status, training progress, associated documents, and evaluation results.

Returns:

alignment_projects: List of alignment project objects, each containing:
- id: Unique alignment project identifier
- name: Project name
- base_model: Base model identifier used for alignment
- status: Project status (pending, completed, failed, deploying, evaluating, evaluated)
- 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

Example Request:

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

Example Response:

{
  "alignment_projects": [
    {
      "id": "alignment-xyz789",
      "name": "Customer Support Domain Alignment",
      "base_model": "nugen-flash-instruct",
      "status": "completed",
      "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
      },
      "evaluation_id": "eval-def456",
      "model_id": "alignment-xyz789-deployed"
    },
    {
      "id": "alignment-abc456",
      "name": "Technical Documentation Alignment",
      "base_model": "nugen-flash-instruct",
      "status": "pending",
      "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 all alignment projects regardless of status
Projects include detailed training progress and performance metrics
Use /alignment/status/{id} to get real-time status for a specific project
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

GET

api

alignment-project

List Alignment Projects

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

{
  "alignment_projects": [
    {
      "id": "<string>",
      "name": "<string>",
      "base_model": "<string>",
      "status": "pending",
      "created_date": "<string>",
      "documents": [
        "<string>"
      ],
      "document_count": 123,
      "creator": "<string>",
      "completed_date": "<string>",
      "performance_metrics": {
        "accuracy_before": 123,
        "accuracy_after": 123,
        "uncertainty_before": 123,
        "uncertainty_after": 123,
        "domain_violations_before": 123,
        "domain_violations_after": 123
      },
      "progress": 123,
      "estimated_completion": "<string>",
      "error": "<string>",
      "evaluation_id": "<string>",
      "model_id": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Response

200 - application/json

Returns a list of all alignment projects for the authenticated user, including project metadata, status, training progress, associated documents, and evaluation results

Response schema for alignment projects listing - matches frontend DomainAlignmentProjects

alignment_projects

AlignmentProject · object[]

required

List of alignment projects

Show child attributes

Get Alignment Status Get Alignment Data

Models

Agents

Documents

Benchmark

Evaluations

Alignment Project

Inference

List Alignment Projects

Authorizations

Response