Models

List Base Models

Retrieve the list of available base models.

This endpoint returns all general-purpose base models available for use in chat completions, embeddings, and domain alignment workflows.

Query Parameters:

  • alignment_ready (optional): true or false
  • inference_ready (optional): true or false
  • type (optional): text-generation or image-text-to-text
  • limit (optional): Number of models to return (1-100, default: 10)
  • offset (optional): Number of models to skip for pagination (default: 0)

Returns:

  • models: List of base model objects, each containing:
    • model_id: Unique model identifier
    • model_name: Human-readable model name
    • parameters: Model parameter count
    • alignment_ready: Whether model can be used as a base for domain alignment
    • inference_ready: Whether model is deployed for chat, completions, embeddings or rerank
    • available_on_request: Whether this model requires an access request before use
    • type: Hugging Face pipeline_tag, text-generation or image-text-to-text. Embedding and reranking base models are not listed; use an aligned model id for both
    • model_card: URL of the model card README on Hugging Face

Example Request:

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

Example Response:

{
  "models": [
    {
      "model_id": "Qwen/Qwen2.5-0.5B-Instruct",
      "model_name": "Qwen/Qwen2.5-0.5B-Instruct",
      "parameters": "0.49B",
      "alignment_ready": true,
      "inference_ready": true,
      "available_on_request": false,
      "type": "text-generation",
      "model_card": "https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct/blob/main/README.md"
    },
    {
      "model_id": "nomic-ai/nomic-embed-text-v1.5",
      "model_name": "nomic-ai/nomic-embed-text-v1.5",
      "parameters": "0.14B",
      "alignment_ready": false,
      "inference_ready": true,
      "available_on_request": false,
      "type": "embedding",
      "model_card": "https://huggingface.co/nomic-ai/nomic-embed-text-v1.5/blob/main/README.md"
    }
  ]
}

Notes:

  • Base models are general-purpose starting points for domain alignment
  • These models can be used directly or as base models for domain alignment
  • Use /models/aligned to see your custom domain-aligned models
  • alignment_ready indicates if the model can be used as a base for domain alignment
get/api/v3/models/base

Request

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

Query parameters

alignment_readyboolean nullable

Only models that can, or cannot, be aligned

inference_readyboolean nullable

Only models that are, or are not, deployed for inference

typestring nullable

Only models whose type matches exactly, e.g. text-generation or embedding

limitinteger

Number of models to return

offsetinteger

Number of models to skip

Response

Returns a list of all available base models that can be used for domain alignment.

Example response

{
  "models": [
    {
      "alignment_ready": true,
      "available_on_request": false,
      "model_id": "Qwen/Qwen2.5-0.5B-Instruct",
      "model_name": "Qwen/Qwen2.5-0.5B-Instruct",
      "parameters": "0.5B",
      "type": "llm"
    },
    {
      "access_request_status": "PENDING",
      "alignment_ready": false,
      "available_on_request": true,
      "model_id": "Qwen/Qwen2.5-1.5B-Instruct",
      "model_name": "Llama V3p3 70b Instruct",
      "parameters": "70B",
      "type": "llm"
    }
  ]
}

Changes

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