GRGlobalRouter Docs
Console

API keys / POST

Create API key

Creates a new tenant API key.

Endpoints

Mobile only shows the endpoint list. View parameter details and examples on desktop.

MethodEndpointDescription
GET/api/v1/keyReads masked information for the API key used by the current request.
GET/api/v1/keysLists API keys owned by the current calling key's owner.
GET/api/v1/keys/{key_ref}Reads masked information for one API key by key reference.
POST/api/v1/keysCreates a new tenant API key.
PATCH/api/v1/keys/{key_ref}Updates an API key's name, scopes, model ranges, source IPs, or rate limit.
DELETE/api/v1/keys/{key_ref}Revokes an API key.
POST/api/v1/keys

The caller must use a key with the management scope. The new key is automatically owned by the calling key's owner. This endpoint cannot grant management; only a Workspace Owner can enable it in Portal.

Back to API keys endpoint list

Request parameters

FieldTypeRequiredDescription
namestringNoKey name for team identification.
scopesstring[]NoBusiness scopes, such as chat, models, or tasks; management is not allowed.
allowed_modelsstring[]NoList of allowed GlobalRouter model IDs.
blocked_modelsstring[]NoList of blocked model IDs.
allowed_ipsstring[]NoSource IP allowlist.
rate_limit_per_minuteintegerNoPer-minute rate limit.
expires_atstringNoExpiration time; ISO 8601 is recommended.

Response fields

FieldTypeRequiredDescription
data.idstringYesAPI key record ID.
data.api_keystringYes新建 Key 的明文值，仅createresponses中returns一次。
data.tenant_idstringYesKey 所属租户 ID。
data.namestringYesKey name.
data.key_prefixstringYesKey 前缀，用于识别与排查。
data.scopesstring[]YesScopes.
data.statusstringYesactive, disabled, or revoked.
data.allowed_modelsstring[]NoModel allowlist.
data.blocked_modelsstring[]NoModel blocklist.
data.allowed_ipsstring[]NoSource IP allowlist.
data.rate_limit_per_minuteintegerNoCurrent rate limit.
data.expires_atstringNo过期时间。
data.last_used_atstringNo最近使用时间。