Router Providers List and Upsert API

# List providers
curl -X GET "https://router.example.com/v1/router/providers" \
  -H "Authorization: Bearer <api-key>"

# Upsert a provider (admin only)
curl -X PUT "https://router.example.com/v1/router/providers" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "openai",
    "default_model": "gpt-4o",
    "models": [
      {"name": "gpt-4o", "backend_ref": "openai/gpt-4o"},
      {"name": "gpt-4o-mini", "backend_ref": "openai/gpt-4o-mini"}
    ]
  }'

{
  "items": [
    {
      "name": "openai",
      "default_model": "gpt-4o",
      "models": [
        {"name": "gpt-4o", "backend_ref": "openai/gpt-4o"},
        {"name": "gpt-4o-mini", "backend_ref": "openai/gpt-4o-mini"}
      ]
    },
    {
      "name": "anthropic",
      "default_model": "claude-3-5-sonnet-20241022",
      "models": [
        {"name": "claude-3-5-sonnet-20241022", "backend_ref": "anthropic/claude-3-5-sonnet"}
      ]
    }
  ]
}

# List providers
curl -X GET "https://router.example.com/v1/router/providers" \
  -H "Authorization: Bearer <api-key>"

# Upsert a provider (admin only)
curl -X PUT "https://router.example.com/v1/router/providers" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "openai",
    "default_model": "gpt-4o",
    "models": [
      {"name": "gpt-4o", "backend_ref": "openai/gpt-4o"},
      {"name": "gpt-4o-mini", "backend_ref": "openai/gpt-4o-mini"}
    ]
  }'

{
  "items": [
    {
      "name": "openai",
      "default_model": "gpt-4o",
      "models": [
        {"name": "gpt-4o", "backend_ref": "openai/gpt-4o"},
        {"name": "gpt-4o-mini", "backend_ref": "openai/gpt-4o-mini"}
      ]
    },
    {
      "name": "anthropic",
      "default_model": "claude-3-5-sonnet-20241022",
      "models": [
        {"name": "claude-3-5-sonnet-20241022", "backend_ref": "anthropic/claude-3-5-sonnet"}
      ]
    }
  ]
}

Use the Providers endpoint to list all configured inference providers or to create and update an individual provider spec. A GET returns the full provider collection. A PUT upserts a provider by its identifier. Only admin callers may modify providers. This is useful when you need to rotate backend references, add new models, or onboard a new provider without replacing the entire router configuration.

Endpoint

GET /v1/router/providers

PUT /v1/router/providers

Authentication

Authenticate with a session cookie or pass Authorization: Bearer <api-key>. The PUT method requires an admin role.

GET Response

array

List of configured providers.

Show items

string

Unique provider identifier.

string

Fallback model when none is specified.

array

Model definitions for this provider.

Show items

string

Model name.

string

Backend endpoint or identifier.

PUT Request Body

string

required

Unique provider identifier.

string

Fallback model when the client omits a model selection.

array

List of model definitions with backend references.

PUT Response

string

Identifier of the upserted provider.

boolean

Whether the provider was updated (true) or created (false).

# List providers
curl -X GET "https://router.example.com/v1/router/providers" \
  -H "Authorization: Bearer <api-key>"

# Upsert a provider (admin only)
curl -X PUT "https://router.example.com/v1/router/providers" \
  -H "Authorization: Bearer <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "openai",
    "default_model": "gpt-4o",
    "models": [
      {"name": "gpt-4o", "backend_ref": "openai/gpt-4o"},
      {"name": "gpt-4o-mini", "backend_ref": "openai/gpt-4o-mini"}
    ]
  }'

{
  "items": [
    {
      "name": "openai",
      "default_model": "gpt-4o",
      "models": [
        {"name": "gpt-4o", "backend_ref": "openai/gpt-4o"},
        {"name": "gpt-4o-mini", "backend_ref": "openai/gpt-4o-mini"}
      ]
    },
    {
      "name": "anthropic",
      "default_model": "claude-3-5-sonnet-20241022",
      "models": [
        {"name": "claude-3-5-sonnet-20241022", "backend_ref": "anthropic/claude-3-5-sonnet"}
      ]
    }
  ]
}

PIN API

ROUTER API

AGENT API

Router Providers List and Upsert API

Endpoint

Authentication

GET Response

PUT Request Body

PUT Response

​Endpoint

​Authentication

​GET Response

​PUT Request Body

​PUT Response

Endpoint

Authentication

GET Response

PUT Request Body

PUT Response