Overview

The /api/v1/models endpoint provides a list of available text generation models. It supports optional detailed information including pricing data. The endpoint maintains full backwards compatibility while adding powerful new features. For embedding models, use the dedicated /api/v1/embedding-models endpoint which provides comprehensive information about all available embedding models.

Compatibility

Responses mirror OpenAI’s Models API shape. All models endpoints return:

{
  "object": "list",
  "data": [ { /* model */ }, ... ]
}

Each model minimally includes:

{
  "id": "openai/gpt-5.2",
  "object": "model",
  "created": 1736966400,
  "owned_by": "openai"
}

Features

Basic Mode: Standard OpenAI-compatible model listing
Detailed Mode: Enhanced information with pricing and model descriptions

Provider Selection Discovery

Provider selection support and provider IDs are discovered via GET /api/models/:canonicalId/providers. See Provider Selection for details.

Query Parameters

Parameter	Type	Default	Description
`detailed`	boolean	`false`	Returns detailed model information including pricing and capabilities

When detailed=true, additional human-friendly fields may be included per model:

name — display name
description — short model description
context_length — max input tokens (if known)
capabilities.vision — whether the model supports native image input
pricing.prompt and pricing.completion — at-cost per-million-token pricing in USD
pricing.unit — per_million_tokens
icon_url — small icon representing the provider
cost_estimate — internal rollup used in UI for cost hints

Authentication

Authentication is optional but enables user-specific pricing in detailed mode:

Header	Format	Required	Description
`Authorization`	`Bearer {api_key}`	Optional	API key for user-specific pricing
`x-api-key`	`{api_key}`	Optional	Alternative API key header

Notes:

Invalid or missing API keys still return a list of models. We simply omit user-specific pricing considerations in detailed=true mode.
With a valid key, the canonical /api/v1/models may apply your account’s subscription visibility preference (see Endpoint Variants).

Response Formats

Basic Response (Default)

Standard OpenAI-compatible format without pricing information:

{
  "object": "list",
  "data": [
    {
      "id": "openai/gpt-5.2",
      "object": "model",
      "created": 1704067200,
      "owned_by": "openai"
    },
    {
      "id": "anthropic/claude-opus-4.5",
      "object": "model", 
      "created": 1704067200,
      "owned_by": "anthropic"
    }
  ]
}

Detailed Response

Enhanced format with model descriptions, context lengths, and pricing:

{
  "object": "list",
  "data": [
    {
      "id": "openai/gpt-5.2",
      "object": "model",
      "created": 1704067200,
      "owned_by": "openai",
      "name": "GPT-5.2",
      "description": "OpenAI's flagship general-purpose model",
      "context_length": 128000,
      "capabilities": { "vision": true },
      "pricing": {
        "prompt": 0.003,
        "completion": 0.012,
        "currency": "USD",
        "unit": "per_million_tokens"
      },
      "icon_url": "/icons/OpenAI.svg",
      "cost_estimate": { "cheap": false }
    },
    {
      "id": "anthropic/claude-opus-4.5",
      "object": "model",
      "created": 1704067200,
      "owned_by": "anthropic",
      "name": "Claude Opus 4.5",
      "description": "Anthropic's top-tier model for deep reasoning and writing",
      "context_length": 200000,
      "capabilities": { "vision": false },
      "pricing": {
        "prompt": 0.003,
        "completion": 0.015,
        "currency": "USD", 
        "unit": "per_million_tokens"
      },
      "icon_url": "/icons/Anthropic.svg"
    }
  ]
}

Field Descriptions

Basic Fields (Always Present)

Field	Type	Description
`id`	string	Unique model identifier
`object`	string	Always “model” for OpenAI compatibility
`created`	number	Unix timestamp of response creation
`owned_by`	string	Model provider (openai, anthropic, meta, google, etc.)

Enhanced Fields (Detailed Mode Only)

Field	Type	Description
`name`	string	Human-readable model name
`description`	string	Detailed model description
`context_length`	number	Maximum input tokens (null if not available)
`capabilities`	object	Feature flags (e.g., `vision: boolean`)
`pricing`	object	Pricing information object
`icon_url`	string	Path/URL for a small provider icon
`cost_estimate`	object	Internal hints (e.g., `{ cheap: true }`)

Pricing Object Structure

Field	Type	Description
`prompt`	number	Cost per million input tokens in USD
`completion`	number	Cost per million output tokens in USD
`currency`	string	Always “USD”
`unit`	string	Always “per_million_tokens”

Usage Examples

Basic Request

curl "https://nano-gpt.com/api/v1/models"

Detailed Request

curl "https://nano-gpt.com/api/v1/models?detailed=true"

Detailed with Authentication

curl "https://nano-gpt.com/api/v1/models?detailed=true" \
  -H "Authorization: Bearer your_api_key_here"

Alternative API Key Header

curl "https://nano-gpt.com/api/v1/models?detailed=true" \
  -H "x-api-key: your_api_key_here"

Endpoint Variants

In addition to the canonical /api/v1/models, two filtered variants are available:

1) GET /api/v1/models (canonical)

Returns all visible text models (excludes internal free/helper selector models except auto-model*).
If your account has an active subscription and you have not enabled “Also show paid models”, the list is automatically restricted to only subscription-included models.
If you enable “Also show paid models” in settings, it returns the full set again.

Examples:

curl -H "Authorization: Bearer $NANOGPT_API_KEY" \
  https://nano-gpt.com/api/v1/models

curl -H "Authorization: Bearer $NANOGPT_API_KEY" \
  "https://nano-gpt.com/api/v1/models?detailed=true"

2) GET /api/subscription/v1/models (subscription-only)

Always returns only models included in the NanoGPT subscription (equivalent to our isTextEligible(modelId) filter).
Ignores the user’s “Also show paid models” preference; it is always subscription-only.
Supports ?detailed=true and API key–aware, at-cost pricing metadata.

Examples:

curl https://nano-gpt.com/api/subscription/v1/models

curl -H "x-api-key: $NANOGPT_API_KEY" \
  "https://nano-gpt.com/api/subscription/v1/models?detailed=true"

3) GET /api/paid/v1/models (paid/extras)

Returns only models that are NOT part of the subscription (paid/premium/extras).
Supports ?detailed=true and API key–aware, at-cost pricing metadata.

Examples:

curl https://nano-gpt.com/api/paid/v1/models

curl -H "Authorization: Bearer $NANOGPT_API_KEY" \
  "https://nano-gpt.com/api/paid/v1/models?detailed=true"

Choosing the Right Endpoint

Use /api/subscription/v1/models for curated lists guaranteed to be subscription-included (e.g., sub-only integrations).
Use /api/paid/v1/models to focus on paid or premium models.
Use /api/v1/models for the canonical list and let the account’s “Also show paid models” preference decide visibility.

Errors and Limits

These endpoints typically return 200 with a list. If an invalid API key is provided, the list still returns and simply omits user-specific pricing considerations in detailed=true mode.
Standard CORS and rate limiting apply. In overload scenarios you may receive 429 with:

{ "code": "rate_limited", "message": "Rate limit exceeded" }

Backwards Compatibility

Default response format unchanged
All existing fields preserved
New fields are additive only
No breaking changes to existing integrations

/api/v1/embedding-models - List all available embedding models with detailed information
/api/v1/embeddings - Create embeddings using the available models
Provider Selection - Discover model providers and set provider preferences
/api/subscription/v1/models - Subscription-included text models
/api/paid/v1/models - Paid or premium text models

Notes

Scope: These endpoints list text-chat models. For image, video, and audio model listings, use GET /api/v1/image-models, GET /api/v1/video-models, and GET /api/v1/audio-models.
Fields are subject to change as new capabilities or providers are added. We aim to remain OpenAI-API compatible for basic consumers (id/object/created/owned_by).

Image, Video, and Audio Model Listings

The following endpoints list non-text model catalogs. Base URL: https://nano-gpt.com/api. All endpoints return JSON. Authentication is not required.

Image models
Video models
Audio models

GET /v1/image-models

Lists all available image generation models.

Query Parameters

Parameter	Type	Default	Description
`detailed`	boolean	`true`	Include pricing, capabilities, and supported parameters

Response

{
  "object": "list",
  "data": [ ... ],
  "meta": {
    "count": 12,
    "generated_at": "2025-01-28T12:00:00.000Z"
  }
}

Each model (detailed):

{
  "id": "flux-pro",
  "object": "model",
  "created": 1706745600,
  "owned_by": "bfl",
  "name": "FLUX Pro",
  "description": "...",
  "architecture": {
    "modality": "text->image",
    "input_modalities": ["text"],
    "output_modalities": ["image"]
  },
  "pricing": {
    "per_image": {
      "1024x1024": 0.05,
      "1024x768": 0.04
    },
    "currency": "USD"
  },
  "capabilities": {
    "image_generation": true,
    "image_to_image": false,
    "inpainting": false,
    "nsfw": false
  },
  "supported_parameters": {
    "resolutions": ["1024x1024", "1024x768", "768x1024"],
    "max_images": 4,
    "fixed_image_count": 1
  },
  "icon_url": "...",
  "tags": ["..."],
  "category": "image"
}

Notes

With detailed=false, the response includes only id, object, created, and owned_by per model.
This endpoint runs on the edge runtime.
Responses are compressed (gzip/brotli) when supported by the client.
Pricing values are in USD.

GET /v1/video-models

Lists all available video generation models.

Query Parameters

Parameter	Type	Default	Description
`detailed`	boolean	`true`	Include pricing, capabilities, and supported parameters

Response

{
  "object": "list",
  "data": [ ... ],
  "meta": {
    "count": 5,
    "generated_at": "2025-01-28T12:00:00.000Z"
  }
}

Each model (detailed):

{
  "id": "kling-video",
  "object": "model",
  "created": 1706745600,
  "owned_by": "kling",
  "name": "Kling Video",
  "description": "...",
  "architecture": {
    "modality": "text+image->video",
    "input_modalities": ["text", "image"],
    "output_modalities": ["video"]
  },
  "pricing": { },
  "capabilities": {
    "video_generation": true,
    "text_to_video": true,
    "image_to_video": true,
    "video_to_video": false,
    "audio_input": false,
    "audio_generation": false,
    "fps_control": false,
    "nsfw": false
  },
  "settings": [ ],
  "icon_url": "...",
  "label": "...",
  "tags": ["..."],
  "category": "video"
}

Notes

With detailed=false, the response includes only id, object, created, and owned_by per model.
Video pricing structures vary by model (per-second, per-generation, tiered by duration, etc.). The pricing object shape depends on the specific model.
This endpoint runs on the edge runtime.
Responses are compressed (gzip/brotli) when supported by the client.
Pricing values are in USD.

GET /v1/audio-models

Lists all available audio models (text-to-speech, speech-to-text, and music generation).

Query Parameters

Parameter	Type	Default	Description
`detailed`	boolean	`true`	Include pricing, capabilities, and supported parameters
`type`	string	`all`	Filter by type: `tts`, `stt`, or `all`

Response

{
  "object": "list",
  "data": [ ... ],
  "meta": {
    "count": 8,
    "generated_at": "2025-01-28T12:00:00.000Z",
    "filter": { "type": "tts" }
  }
}

The filter field in meta is only present when type is not all.

TTS model (detailed)

{
  "id": "openai-tts",
  "object": "model",
  "created": 1706745600,
  "owned_by": "openai",
  "name": "OpenAI TTS",
  "description": "...",
  "architecture": {
    "modality": "text->audio",
    "input_modalities": ["text"],
    "output_modalities": ["audio"]
  },
  "pricing": {
    "per_thousand_chars": 0.015,
    "currency": "USD"
  },
  "capabilities": {
    "text_to_speech": true
  },
  "supported_parameters": {
    "max_chars": 4096,
    "voices": ["alloy", "echo", "fable", "onyx", "nova", "shimmer"]
  },
  "icon_url": "...",
  "category": "audio_tts"
}

Music model (detailed)

{
  "id": "music-model",
  "object": "model",
  "created": 1706745600,
  "owned_by": "...",
  "name": "...",
  "description": "...",
  "architecture": {
    "modality": "text->music",
    "input_modalities": ["text"],
    "output_modalities": ["music"]
  },
  "pricing": {
    "per_second": 0.01,
    "minimum": 0.05,
    "currency": "USD"
  },
  "capabilities": {
    "text_to_music": true
  },
  "supported_parameters": {
    "min_duration": 5,
    "max_duration": 300
  },
  "icon_url": "...",
  "category": "audio_music"
}

STT model (detailed)

{
  "id": "whisper-large-v3",
  "object": "model",
  "created": 1706745600,
  "owned_by": "openai",
  "name": "Whisper Large V3",
  "description": "...",
  "architecture": {
    "modality": "audio->text",
    "input_modalities": ["audio"],
    "output_modalities": ["text"]
  },
  "pricing": {
    "per_minute": 0.006,
    "currency": "USD"
  },
  "capabilities": {
    "speech_to_text": true,
    "diarization": true,
    "word_timestamps": true
  },
  "supported_parameters": {
    "max_file_size_mb": 25,
    "supported_formats": ["mp3", "wav", "webm", "mp4", "m4a", "ogg", "flac"],
    "supported_languages": ["en", "es", "fr", "..."],
    "features": ["Speaker diarization", "Word-level timestamps"]
  },
  "icon_url": "...",
  "category": "audio_stt"
}

Notes

With detailed=false, the response includes only id, object, created, and owned_by per model.
This endpoint runs on the edge runtime.
Responses are compressed (gzip/brotli) when supported by the client.
Pricing values are in USD.

Authorizations

Authorization

string

header

required

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

Query Parameters

detailed

boolean

default:false

Returns detailed model information including pricing

Response

List of available models

object

string

default:list

Type of object, always 'list' for the models response

data

object[]

List of available models

Show child attributes

Get Started

Endpoint Examples

API Reference

Miscellaneous

Integrations

​Overview

​Compatibility

​Features

​Provider Selection Discovery

​Query Parameters

​Authentication

​Response Formats

​Basic Response (Default)

​Detailed Response

​Field Descriptions

​Basic Fields (Always Present)

​Enhanced Fields (Detailed Mode Only)

​Pricing Object Structure

​Usage Examples

​Basic Request

​Detailed Request

​Detailed with Authentication

​Alternative API Key Header

​Endpoint Variants

​1) GET /api/v1/models (canonical)

​2) GET /api/subscription/v1/models (subscription-only)

​3) GET /api/paid/v1/models (paid/extras)

​Choosing the Right Endpoint

​Errors and Limits

​Backwards Compatibility

​Related Endpoints

​Notes

​Image, Video, and Audio Model Listings

​GET /v1/image-models

​Query Parameters

​Response

​Notes

​GET /v1/video-models

​Query Parameters

​Response

​Notes

​GET /v1/audio-models

​Query Parameters

​Response

​TTS model (detailed)

​Music model (detailed)

​STT model (detailed)

​Notes

Authorizations

Query Parameters

Response

Overview

Compatibility

Features

Provider Selection Discovery

Query Parameters

Authentication

Response Formats

Basic Response (Default)

Detailed Response

Field Descriptions

Basic Fields (Always Present)

Enhanced Fields (Detailed Mode Only)

Pricing Object Structure

Usage Examples

Basic Request

Detailed Request

Detailed with Authentication

Alternative API Key Header

Endpoint Variants

1) GET /api/v1/models (canonical)

2) GET /api/subscription/v1/models (subscription-only)

3) GET /api/paid/v1/models (paid/extras)

Choosing the Right Endpoint

Errors and Limits

Backwards Compatibility

Related Endpoints

Notes

Image, Video, and Audio Model Listings

GET /v1/image-models

Query Parameters

Response

Notes

GET /v1/video-models

Query Parameters

Response

Notes

GET /v1/audio-models

Query Parameters

Response

TTS model (detailed)

Music model (detailed)

STT model (detailed)

Notes