List Aligned Models

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

{
  "domain_aligned_models": [
    {
      "id": [
        "alignment-xyz789-deployed",
        "alignment-abc456"
      ],
      "name": [
        "customer_support_model",
        "legal_document_assistant",
        "medical_qa_assistant"
      ],
      "base_model": [
        "nugen-flash-instruct",
        "model-20240229"
      ],
      "alignment_project": [
        "Customer Support Alignment",
        "Legal Domain Alignment"
      ],
      "created_date": [
        "2024-01-15T10:30:00Z"
      ],
      "status": [
        "DEPLOYED",
        "READY",
        "DEPLOYING",
        "FAILED"
      ],
      "endpoint": [
        "https://api.nugen.in/api/v3/inference/completions/alignment-xyz789-deployed"
      ],
      "creator": [
        "user@example.com"
      ],
      "usage_count": [
        150
      ],
      "performance_metrics": {
        "accuracy": [
          0.92,
          0.88,
          0.75
        ],
        "uncertainty": [
          0.15,
          0.18,
          0.35
        ],
        "domain_violations": [
          2,
          3,
          12
        ],
        "average_response_time": [
          1.2,
          0.8,
          2.5
        ]
      },
      "downloadable": [
        true,
        false
      ],
      "alignment_id": [
        "alignment-xyz789",
        "alignment-abc456"
      ],
      "last_used": [
        "2024-01-20T14:30:00Z",
        null
      ],
      "evaluation_data": [
        {
          "completed_at": "2024-01-16T08:00:00Z",
          "evaluation_id": "eval-abc123",
          "metrics": {
            "accuracy": 0.92,
            "uncertainty": 0.15
          },
          "raw_answers_count": 50,
          "status": "READY"
        }
      ],
      "conversation_saving_enabled": false
    }
  ]
}

Models

List Aligned Models

Retrieve all domain-aligned models for the authenticated user.

This endpoint returns a list of custom models that have been created through domain alignment workflows, including their deployment status, evaluation results, and conversation settings.

Returns:

domain_aligned_models: List of aligned model objects, each containing:
- id: Unique model identifier (or alignment-{id} for un-deployed models)
- alignment_id: Original alignment project ID
- name: Model name
- base_model: Base model used for alignment
- alignment_project: Name of the alignment project
- created_date: Creation timestamp
- status: Model status (e.g., DEPLOYED, UNDEPLOYED, DEPLOYING, UNDEPLOYING, EVALUATED)
- deployment_status: Current deployment state (DEPLOYED or UNDEPLOYED)
- endpoint: Inference endpoint URL (only for deployed models)
- creator: Username/email of the model creator
- usage_count: Number of times the model has been used for inference
- last_used: Timestamp of last usage
- performance_metrics: Model performance statistics
- downloadable: Whether model can be downloaded
- evaluation_data: Benchmark evaluation results (if available)
- conversation_saving_enabled: Whether conversation saving is enabled for this model

Example Request:

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

Example Response:

{
  "domain_aligned_models":
    [
    {
      "id": "aligned-model-01kmqm4nrn9fw6r",
      "alignment_id": "alignment-xyz789",
      "name": "customer_support_model",
      "base_model": "nugen-flash-instruct",
      "alignment_project": "Customer Support Alignment",
      "created_date": "2024-01-15T10:30:00Z",
      "status": "DEPLOYED",
      "deployment_status": "DEPLOYED",
      "endpoint": "https://api.example.com/v1/models/alignment-xyz789",
      "creator": "user@example.com",
      "usage_count": 150,
      "last_used": "2024-01-20T14:30:00Z",
      "performance_metrics": {
        "accuracy_before": 0.75,
        "accuracy_after": 0.92,
        "uncertainty_before": 0.35,
        "uncertainty_after": 0.15,
        "domain_violations_before": 12,
        "domain_violations_after": 2
      },
      "downloadable": true,
      "evaluation_data": {
        "accuracy": 0.92,
        "total_questions": 50
      },
      "conversation_saving_enabled": true
    }
    ]
}

Notes:

Returns both deployed and undeployed aligned models
evaluation_data is included if the model was evaluated against a benchmark
performance_metrics show before/after alignment improvements
conversation_saving_enabled indicates whether chat history is saved for each model
Use /models/base to see available base models for alignment

GET

api

models

aligned

List Aligned Models

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

{
  "domain_aligned_models": [
    {
      "id": [
        "alignment-xyz789-deployed",
        "alignment-abc456"
      ],
      "name": [
        "customer_support_model",
        "legal_document_assistant",
        "medical_qa_assistant"
      ],
      "base_model": [
        "nugen-flash-instruct",
        "model-20240229"
      ],
      "alignment_project": [
        "Customer Support Alignment",
        "Legal Domain Alignment"
      ],
      "created_date": [
        "2024-01-15T10:30:00Z"
      ],
      "status": [
        "DEPLOYED",
        "READY",
        "DEPLOYING",
        "FAILED"
      ],
      "endpoint": [
        "https://api.nugen.in/api/v3/inference/completions/alignment-xyz789-deployed"
      ],
      "creator": [
        "user@example.com"
      ],
      "usage_count": [
        150
      ],
      "performance_metrics": {
        "accuracy": [
          0.92,
          0.88,
          0.75
        ],
        "uncertainty": [
          0.15,
          0.18,
          0.35
        ],
        "domain_violations": [
          2,
          3,
          12
        ],
        "average_response_time": [
          1.2,
          0.8,
          2.5
        ]
      },
      "downloadable": [
        true,
        false
      ],
      "alignment_id": [
        "alignment-xyz789",
        "alignment-abc456"
      ],
      "last_used": [
        "2024-01-20T14:30:00Z",
        null
      ],
      "evaluation_data": [
        {
          "completed_at": "2024-01-16T08:00:00Z",
          "evaluation_id": "eval-abc123",
          "metrics": {
            "accuracy": 0.92,
            "uncertainty": 0.15
          },
          "raw_answers_count": 50,
          "status": "READY"
        }
      ],
      "conversation_saving_enabled": false
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Response

Returns a list of all domain-aligned models created by the authenticated user.

domain_aligned_models

DomainAlignedModel · object[]

required

List of domain-aligned models with their deployment status, performance metrics, and evaluation data

Show child attributes

List Base Models Deploy Aligned Model