For the complete documentation index, see llms.txt. This page is also available as Markdown.

Providers

List Providers

get

List static metadata for every configured provider.

Operator-facing: reports each provider's capabilities, documentation and pricing links, and display name from the bundled any-llm and models.dev datasets. No provider is contacted, so this is cheap and always available.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Responses
200

Successful Response

application/json

Metadata for every configured provider.

get/api/v1/providers
GET /api/v1/providers HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
200

Successful Response

{
  "providers": [
    {
      "capabilities": {
        "audio": true,
        "embeddings": true,
        "image_generation": true,
        "list_models": true,
        "moderation": true,
        "pdf": true,
        "reasoning": true,
        "rerank": true,
        "responses_api": true,
        "streaming": true,
        "vision": true
      },
      "description": "text",
      "doc_url": "text",
      "env_key": "text",
      "instance": "text",
      "name": "text",
      "pricing_urls": [
        "text"
      ],
      "provider_type": "text",
      "source": "config"
    }
  ]
}

Provider Catalog

get

List every known provider for the add-provider picker: id and name only.

Lightweight by design so the picker never lags: provider ids come from the any-llm registry and names from the models.dev catalog, so no provider SDK is imported. The autofill hints for a chosen provider come from GET /api/v1/providers/catalog/{provider_id}, which imports only that one SDK.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Responses
200

Successful Response

application/json

A provider offered in the add-provider picker: id and display name only.

idstringRequired

any-llm provider id, used as the default instance name.

namestringRequired

Human-friendly display name.

get/api/v1/providers/catalog
GET /api/v1/providers/catalog HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
200

Successful Response

[
  {
    "id": "text",
    "name": "text"
  }
]

Provider Catalog Detail

get

Autofill hints for one provider the add-provider form has selected.

Imports only the selected provider's any-llm module (not the whole catalog) to report its credential env var, default endpoint, whether a key is required, and whether that env var is already set on the server. Returns 404 for an unknown provider id.

The SDK import is offloaded to a worker thread: the first fetch for a given provider imports that provider's module, which would otherwise block the event loop (and thus every concurrent request) for the import's duration.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
provider_idstringRequired
Responses
200

Successful Response

application/json

A selected provider's autofill hints for the add-provider form.

default_api_basestring · nullableOptional

Built-in endpoint; blank means the SDK's default.

env_keystring · nullableOptional

Env var the SDK reads this provider's key from.

env_key_presentbooleanOptional

True when env_key is set on the server. Informational: a stored provider never reads it, so a key the provider requires must still be supplied.

Default: false
idstringRequired

any-llm provider id, used as the default instance name.

namestringRequired

Human-friendly display name.

requires_api_keybooleanRequired

False for providers that need no key: keyless local backends (Ollama, llama.cpp) and ambient cloud credentials (Bedrock, Vertex AI).

get/api/v1/providers/catalog/{provider_id}
GET /api/v1/providers/catalog/{provider_id} HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
{
  "default_api_base": "text",
  "env_key": "text",
  "env_key_present": false,
  "id": "text",
  "name": "text",
  "requires_api_key": true
}

Provider Health

get

Report every configured provider's reachability, with a last-checked time.

Covers the configured provider instances and every hosted provider switched on, each hosted provider under its provider name. A hosted provider that a configured instance of the same name shadows is not reported. One whose stored key cannot be decrypted with the configured OTARI_SECRET_KEY is reported unreachable with that reason.

Reuses the per-provider model-discovery test path, so a provider is healthy when its credentials can list models. Results are served from the discovery cache (cheap enough to poll), so checked_at reflects when each provider was actually dialed. Pass refresh=true to force a live re-dial of every provider.

A provider whose backend serves no model-listing endpoint cannot be verified this way, but it is not unreachable either: it is reported with discovery_unsupported and counted under degraded rather than as a reachability failure.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Query parameters
refreshbooleanOptionalDefault: false
Responses
200

Successful Response

application/json

Provider connectivity across the whole gateway, for the health monitor.

Carries per-provider results plus the healthy / total counts and the most recent checked_at so the overview page can render a summary tile without re-deriving them.

checked_atstring · nullableOptional

ISO 8601 time of the most recent per-provider check (null if none yet).

degradedintegerOptional

How many providers are not counted as reachable only because model discovery is unavailable for them. These may still serve requests.

Default: 0
healthyintegerRequired

How many providers are currently reachable.

totalintegerRequired

How many providers are configured.

get/api/v1/providers/health
GET /api/v1/providers/health HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
{
  "checked_at": "text",
  "degraded": 0,
  "healthy": 1,
  "providers": [
    {
      "checked_at": "text",
      "discovery_unsupported": false,
      "error": "text",
      "instance": "text",
      "model_count": 1,
      "ok": true
    }
  ],
  "total": 1
}

Last updated

Was this helpful?