Skip to main content
GET
Get Api Token Scopes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

xi-api-key
string | null
x-api-key
string | null

Response

Successful Response

name
enum<string>
required

What an API key may do; a login session may do everything. Listed in the order the dashboard shows.

A scope x also grants x:read (see covers_scope).

Adding or renaming a scope needs its dashboard description in deepinfra/web too: pages.dashboard.api_keys.scopes.descriptions.<name with ':' as '_'> in public/locales/en/common.json. Without one the dashboard shows the bare name.

A new scope is not initial, so unrestricted keys do not get it; one split from an initial scope is, so they keep what they could do.

Available options:
inference,
models:read,
account:read,
models,
lora:read,
lora,
voice:read,
voice,
account_scoped_jwt:read,
account_scoped_jwt,
batch,
compute:sandbox,
compute:agents,
compute:containers,
billing:read,
metrics,
unrestricted
is_default
boolean
required

preselected for a new key

is_initial
boolean
required

granted by the deprecated unrestricted scope