Claude Platform Docs

Chaves de API

Listar chaves de API
GET/v1/organizations/api_keys
Recuperar chave de API (Admin API)
GET/v1/organizations/api_keys/{api_key_id}

Recupere informações sobre uma única chave de API na sua organização, consultada pelo ID. Este endpoint da Admin API requer uma chave de API Admin, destina-se ao gerenciamento programático de chaves e nunca retorna o valor secreto da chave. Para visualizar ou criar suas próprias chaves de API, acesse Chaves de API no Claude Console.

Atualizar chave de API
POST/v1/organizations/api_keys/{api_key_id}
Models
APIKey object{ type: "api_key", id, created_at, 8 more }
APIKeyCreatedBy object{ type, id }
type: "service_account" or "user"

Type of the actor that created the object.

One of the following:
"service_account"
"user"
id: string

ID of the actor that created the object.

APIKeyOrganizationScope object{ type: "organization" }
type: "organization"

Scope type. Always "organization": the API key has no Workspace. Only a principal-bound API key can have this scope.

defaultorganization
APIKeyServiceAccountActor object{ type: "service_account_actor", service_account_id }
type: "service_account_actor"

Principal type. Always "service_account_actor" for a Service Account.

defaultservice_account_actor
service_account_id: string

ID of the Service Account the API key acts as.

APIKeyUserActor object{ type: "user_actor", user_id }
type: "user_actor"

Principal type. Always "user_actor" for a User.

defaultuser_actor
user_id: string

ID of the User the API key acts as.

APIKeyWorkspaceScope object{ type: "workspace", workspace_id }
type: "workspace"

Scope type. Always "workspace": the API key belongs to one Workspace.

defaultworkspace
workspace_id: string

ID of the Workspace the API key belongs to. Unlike the deprecated top-level workspace_id, this is the Workspace's real ID even for the organization's default Workspace.