Models

List Aligned Models

Retrieve all domain-aligned models for the authenticated user.

This endpoint returns a lean list row per aligned model. Fetch GET /models/{model_id} for the full record: performance metrics, evaluation data, usage, downloadability and conversation settings.

Query Parameters:

  • deployment_status (optional): UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING
  • base_model_id (optional): exact base model id, e.g. Qwen/Qwen2.5-0.5B-Instruct
  • limit (optional): Number of models to return (1-100, default: 10)
  • offset (optional): Number of models to skip for pagination (default: 0)

Returns:

  • domain_aligned_models: List of aligned model objects, each containing:
    • model_id: Unique model identifier (or alignment-{id} for un-deployed models)
    • model_name: Model name
    • deployment_status: UNDEPLOYED, DEPLOYING, DEPLOYED or UNDEPLOYING. Only DEPLOYED serves inference.
    • base_model_id: Base model used for alignment
    • alignment_id: The alignment project that produced this model
    • created_at: Creation timestamp

Example Request:

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

Example Response:

{
  "domain_aligned_models": [
    {
      "model_id": "model_01kmqm4nrn9fw6r",
      "model_name": "customer_support_model",
      "deployment_status": "DEPLOYED",
      "base_model_id": "Qwen/Qwen2.5-0.5B-Instruct",
      "alignment_id": "alignment_01k4x9m2p7q3r8c1",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Notes:

  • Returns both deployed and undeployed aligned models
  • Use /models/base to see available base models for alignment
get/api/v3/models/aligned

Request

  • Base URL
    https://api.nugen.in
  • Auth
    HTTP bearer

Query parameters

deployment_status'UNDEPLOYED' | 'DEPLOYING' | 'DEPLOYED' | 'UNDEPLOYING'

Where a model rests, and what it passes through in between. Only DEPLOYED serves inference. A failed attempt settles back to the state it came from and puts the reason in error.

Only models in this deployment state

base_model_idstring nullable

Only models aligned from this base model, by exact id

limitinteger

Number of models to return

offsetinteger

Number of models to skip

Response

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

Example response

{
  "domain_aligned_models": [
    {
      "base_model_id": "Qwen/Qwen2.5-0.5B-Instruct",
      "base_model_name": "Qwen/Qwen2.5-0.5B-Instruct",
      "created_at": "2024-01-15T10:30:00Z",
      "deployment_status": "DEPLOYED",
      "model_id": "model_01k4x9m2p7q3r9d1",
      "model_name": "model_contract_risk"
    },
    {
      "base_model_id": "Qwen/Qwen2.5-1.5B-Instruct",
      "base_model_name": "Llama V3p3 70b Instruct",
      "created_at": "2024-02-01T09:15:00Z",
      "deployment_status": "UNDEPLOYED",
      "model_id": "model_01k4x9m2p7q3r9d2",
      "model_name": "model_clinical_coding"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.