Providers

List Providers

Every provider kind (language model, embeddings, web search, speech to text, text to speech, voice agent model, telephony, enrichment): the providers it can use, the server's env default and this workspace's override. Resolution: workspace override, else the env default. Credentials are never returned (`credentials_configured`). Owners and admins.

API key access

Needs the admin scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
GET/api/v1/settings/providers
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/settings/providers" \  -H "X-Workspace-Id: string"
{
  "items": [
    {
      "kind": "llm",
      "label": "string",
      "description": "string",
      "source": "workspace",
      "providers": [
        {
          "name": "openai_compatible",
          "label": "string",
          "base_url": "required",
          "model": "required",
          "api_key": "required",
          "api_secret": true,
          "default_base_url": "string",
          "default_model": "string"
        }
      ],
      "option_names": [
        "string"
      ],
      "default": {
        "provider": "string",
        "model": "string"
      },
      "override": {}
    }
  ],
  "allow_private_urls": true
}
Empty