Claude Platform Docs

API Keys

List API Keys
beta.organization.api_keys.list(APIKeyListParams**kwargs) -> SyncPage[BetaAPIKey]
GET/v1/organizations/api_keys
Get API Key
beta.organization.api_keys.retrieve(strapi_key_id) -> BetaAPIKey
GET/v1/organizations/api_keys/{api_key_id}
Update API Key
beta.organization.api_keys.update(strapi_key_id, APIKeyUpdateParams**kwargs) -> BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}
Models
class BetaAPIKey: …
class BetaAPIKeyCreatedBy: …
id: str

ID of the actor that created the object.

type: Literal["service_account", "user"]

Type of the actor that created the object.

One of the following:
"service_account"
"user"
class BetaAPIKeyOrganizationScope: …
type: Literal["organization"]

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

defaultorganization
class BetaAPIKeyServiceAccountActor: …
service_account_id: str

ID of the Service Account the API key acts as.

type: Literal["service_account_actor"]

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

defaultservice_account_actor
class BetaAPIKeyUserActor: …
type: Literal["user_actor"]

Principal type. Always "user_actor" for a User.

defaultuser_actor
user_id: str

ID of the User the API key acts as.

class BetaAPIKeyWorkspaceScope: …
type: Literal["workspace"]

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

defaultworkspace
workspace_id: str

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.