multi-router.aidocs

API Access

Scope

Full control and scoped keys, every scope, and the endpoints each one covers.

A scope is a permission on an API key to use a group of endpoints, such as sending inference requests or changing routers. A key either has full control, with no restriction, or a set of scopes that names exactly what it can do. Scopes are chosen in the Access editor when a key is created, and changed later with Access on the key's row.

Full control and scoped keys

The Access editor sets a key to one of two modes:

ModeDashboard labelKey can
Full controlFull controlUse every endpoint the organization can, including endpoints added to the API later.
ScopedScopedUse only the endpoints its scopes name. Endpoints added later stay closed until a scope for them is granted.

A scoped key with an empty set shows as No access in the list. Scoped keys suit applications: a key that holds only inference keeps routers and prompts safe from change if it leaks.

Data plane scopes

Data plane scopes cover sending requests to models and listing them:

ScopeDashboard rowEndpoint
inferenceInferencePOST /v1/chat/completions
inferenceInferencePOST /v1/messages
inferenceInferencePOST /v1/messages/count_tokens
inferenceInferencePOST /v1/responses
inferenceInferenceThe Claude Proxy Bedrock endpoints under /bedrock
inferenceInferenceThe Claude Proxy Vertex endpoints under /vertex
inferenceInferenceThe Gemini Proxy endpoints under /v1beta/models
models:readModel catalogGET /v1/models

The Inference row offers None, Any router, or Specific routers, which limits the key to a list of routers. See Router Access.

Control plane scopes

API Keys

Bearer tokens used to call /v1/*. Scoped to your account.

New API key
  • support-bot
    Support widget on the help center
    Inferencert_9Hk3Ws7PzQ, production·Modelsread
    sk-mr-xYzQ••••••••••••••••••••••••••••CopyCreated 9/28/2026
    AccessDisableDelete
  • deploy-pipeline
    CI job that manages routers and prompts
    Routerswrite·Promptswrite·Model groupsread
    sk-mr-4bTn••••••••••••••••••••••••••••CopyCreated 9/12/2026
    AccessDisableDelete
    Access
    ScopedFull control
    PresetsInference onlyRead everythingNothing
    Data plane
    Inference
    chat/completions · messages · responses · codex
    inference
    NoneAny routerSpecific routers
    Model catalog
    list the models available to this organization
    models
    NoneRead
    Control planeone level per resource group
    Routers
    routers, aliases and their configuration
    routers
    NoneReadWriteDelete
    Prompts
    prompt bodies and their revisions
    prompts
    NoneReadWriteDelete
    Prompt repos
    connected repos and tracked prompt files
    prompt_repos
    NoneReadWriteDelete
    GitHub
    connected GitHub accounts
    list and disconnect only — connecting an account is a dashboard step
    github
    NoneReadDelete
    Provider keys
    upstream provider credentials
    read-only over the API — keys are managed from the dashboard
    provider_keys
    NoneRead
    Model groups
    organization-owned model sets and their membership
    model_groups
    NoneReadWriteDelete
    Budgets
    spending limits and their status
    budgets
    NoneReadWriteDelete

    Every row works the same way: pick one level, and each level includes the ones before it. Read lists and inspects. Write adds create and edit. Delete adds removal — the only irreversible one, and on routers it also orphans that router's traffic history. Groups show only the levels the API supports.

    CancelSave
  • priya-claude-codemanaged
    Provisioned from the onboarding portal
    Inferencert_5Tc7Hn1GsR
    sk-mr-Lp8w••••••••••••••••••••••••••••CopyCreated 8/30/2026
    AccessDisableDelete
  • analytics-readonlydisabled
    Inferenceany router·Modelsread·Routersread·Promptsread·Prompt reposread·GitHubread·Provider keysread·Model groupsread·Budgetsread
    sk-mr-9cRd••••••••••••••••••••••••••••CopyCreated 7/2/2026
    AccessEnableDelete
  • legacy-admin
    Full controlevery capability, including ones added to the API later
    sk-mr-Qe2v••••••••••••••••••••••••••••CopyCreated 3/4/2026
    AccessDisableDelete
The Access editor for a deployment key: Inference off, Write on Routers and Prompts, and Read on Model groups. Select to enlarge.

Control plane scopes cover managing resources through the API. Each resource group has levels that build on each other: read allows reading, write adds creating and changing, and delete adds deleting. A key holds one level per group. Reading uses GET, writing uses POST and PATCH, and deleting uses DELETE.

ScopeDashboard rowLevelAllows
routers:readRoutersReadReading on /v1/routers
routers:writeRoutersWriteReading, creating and changing on /v1/routers
routers:deleteRoutersDeleteReading, creating, changing and deleting on /v1/routers
prompts:readPromptsReadReading on /v1/prompts
prompts:writePromptsWriteReading, creating and changing on /v1/prompts
prompts:deletePromptsDeleteReading, creating, changing and deleting on /v1/prompts
prompt_repos:readPrompt reposReadReading on /v1/prompt-repos
prompt_repos:writePrompt reposWriteReading, creating and changing on /v1/prompt-repos
prompt_repos:deletePrompt reposDeleteReading, creating, changing and deleting on /v1/prompt-repos
github:readGitHubReadReading on /v1/github/connections
github:deleteGitHubDeleteReading and deleting on /v1/github/connections
provider_keys:readProvider keysReadReading on /v1/provider-keys
provider_keys:writeProvider keysWriteReading, creating and changing on /v1/provider-keys
provider_keys:deleteProvider keysDeleteReading, creating, changing and deleting on /v1/provider-keys
integrations:readNot shownReadReading on /v1/integration-types, /v1/integrations and /v1/routers/{id}/integrations
integrations:writeNot shownWriteReading, creating, changing, testing and deleting on /v1/integrations, and attaching, changing, ordering and detaching on /v1/routers/{id}/integrations
model_groups:readModel groupsReadReading on /v1/model-groups
model_groups:writeModel groupsWriteReading, creating and changing on /v1/model-groups
model_groups:deleteModel groupsDeleteReading, creating, changing and deleting on /v1/model-groups
budgets:readBudgetsReadReading on /v1/budgets
budgets:writeBudgetsWriteReading, creating and changing on /v1/budgets
budgets:deleteBudgetsDeleteReading, creating, changing and deleting on /v1/budgets
traffic:readTrafficReadReading on /v1/traffic
traffic:revealTraffic originalsRevealreveal=true on GET /v1/traffic/requests/{request_id}/payload, with traffic:read
tags:readTagsReadReading on /v1/tags
api_tokens:readAPI tokensReadReading on /v1/api-tokens
agents:readAgentsReadReading on /v1/agents
agents:deleteAgentsDeleteReading and deleting on /v1/agents
organizations:readOrganizationsReadReading on /v1/organizations
organizations:writeOrganizationsWriteReading, creating and changing on /v1/organizations
organizations:deleteOrganizationsDeleteReading, creating, changing and deleting on /v1/organizations
invites:readInvitesReadReading on /v1/people/invites
invites:writeInvitesWriteReading, creating and changing on /v1/people/invites
invites:deleteInvitesDeleteReading, creating, changing and deleting on /v1/people/invites
sso:readSSOReadReading on /v1/sso
sso:writeSSOWriteReading, creating and changing on /v1/sso
sso:deleteSSODeleteReading, creating, changing and deleting on /v1/sso
machine_identity:readMachine identityReadReading on /v1/machine-identity
machine_identity:writeMachine identityWriteReading, creating and changing on /v1/machine-identity
machine_identity:deleteMachine identityDeleteReading, creating, changing and deleting on /v1/machine-identity

GitHub connections and agents are read and removed through the API, and set up in the dashboard and the Portal, so those groups have no write level. Integrations have read and write levels, and deleting an integration or detaching it from a router needs write. The Access editor has no Integrations row, so full control keys reach the integrations endpoints. traffic:reveal is separate from the Traffic levels, and only an organization admin can grant it. Traffic, tags and API tokens are read-only through the API. Three GET endpoints need budgets:write: a budget's overrides, its budget requests and one budget request. The catalog endpoints under /v1/catalog need models:read.

Presets

Presets set every row of the Access editor at once:

PresetScopes
Inference onlyinference on any router, and models:read. New keys start with this preset.
Read everythinginference, models:read, and Read on every control plane row.
NothingAn empty set of scopes.

When every group is set to its highest level, the editor notes that the key still holds a fixed list, and offers Switch to Full control for a key that should also reach endpoints added later.

Examples

Common keys and the access each needs:

Key forAccess
A production applicationInference only, with a router list naming the routers it calls.
A script that audits router and prompt configurationRead on Routers, Prompts and Model groups, with Inference set to None.
A deployment pipeline that manages routers and promptsRouters, Prompts and Model groups at Write or Delete, with Inference set to None.
Claude Desktopinference and models:read, limited to its Claude Proxy.

Scope names

Each scope has a name, such as routers:write, which error messages use to say which scope a request needs. A key holds one level per group, and each level includes the ones below it, so a key with routers:write also reads routers. Workloads that sign in with Machine Identity hold inference. See Machine Identity.

Errors

A scoped key that calls an endpoint outside its scopes receives one of these responses:

StatusResponseCause
403insufficient_scope, with the message this API key is not permitted to use this endpoint; it requires the <scope> scopeThe endpoint needs a scope the key lacks. The message names the lowest scope that allows the request.
403insufficient_scope, with the message this API key is not permitted to use this endpointThe endpoint belongs to no scope the key can hold, such as a newer endpoint.
403API token lacks the required inference scopeA Bedrock or Vertex request through a Claude Proxy, from a key without inference.
404not foundThe method is not one the group offers, such as a write to provider keys.
API KeyRouter Access
Was this helpful?