Models

GET /v1/models Returns the list of models available from the configured provider. When a provider, virtual key, or config is specified in the request headers, the gateway forwards the request to that provider and returns its model list directly. If no provider is specified and a Portkey control-plane URL is configured (ALBUS_BASEPATH), the gateway proxies the request to the Portkey platform to retrieve the available models across your configured integrations.

Request

string

The provider to retrieve models from (e.g. openai, anthropic, azure-openai). When provided, the gateway forwards the request directly to the provider.

string

required

Your Portkey API key, or the provider API key if using provider headers directly.

string

A Portkey virtual key. When set, the gateway routes to the provider associated with that virtual key.

string | object

A Portkey config object or config ID. The gateway reads the provider or virtual_key from the config to determine the target.

Response

string

Always list.

array

Show model object

string

The model identifier used in API requests (e.g. gpt-4o, claude-3-5-sonnet-20241022).

string

Always model.

number

Unix timestamp of when the model was created.

string

The organization that owns the model.

Examples

curl https://your-gateway.example.com/v1/models \
  -H "x-portkey-api-key: YOUR_API_KEY" \
  -H "x-portkey-provider: openai"

from openai import OpenAI

client = OpenAI(
    base_url="https://your-gateway.example.com/v1",
    api_key="YOUR_API_KEY",
    default_headers={
        "x-portkey-provider": "openai",
    },
)

models = client.models.list()
for model in models.data:
    print(model.id)

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://your-gateway.example.com/v1",
  apiKey: "YOUR_API_KEY",
  defaultHeaders: {
    "x-portkey-provider": "openai",
  },
});

const models = await client.models.list();
for (const model of models.data) {
  console.log(model.id);
}

Routing behavior

The modelsHandler determines where to send the request based on the following precedence:

Provider header present (x-portkey-provider, x-portkey-virtual-key, or provider/virtual_key in config) — forwards the request to that specific provider’s models endpoint.
No provider specified with ALBUS_BASEPATH configured — proxies to the Portkey control plane at /v2/models to retrieve the aggregated model list across your integrations.
No provider and no control plane — the request falls through to the next middleware handler.

When using virtual keys, the gateway resolves the underlying provider credentials automatically. You do not need to pass a separate provider API key.

Overview

Chat

Multimodal

Files & Batches

Other

Request

Response

Examples

Routing behavior

​Request

​Response

​Examples

​Routing behavior

Request

Response

Examples

Routing behavior