Claude Platform Docs

Workspace

Elenca i workspace
GET/v1/organizations/workspaces
Crea workspace
POST/v1/organizations/workspaces
Ottieni workspace
GET/v1/organizations/workspaces/{workspace_id}
Aggiorna workspace
POST/v1/organizations/workspaces/{workspace_id}
Archivia workspace
POST/v1/organizations/workspaces/{workspace_id}/archive
Models
AllowedInferenceGeo = "global" or "us"
One of the following:
"global"
"us"
DataResidency object{ allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: array of AllowedInferenceGeo or "unrestricted"

Permitted inference geo values. 'unrestricted' means all geos are allowed.

One of the following:
Geos = array of AllowedInferenceGeo
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: "global" or "us"

Default inference geo applied when requests omit the parameter.

One of the following:
"global"
"us"
workspace_geo: "us"

Geographic region for workspace data storage. Immutable after creation.

DataResidencyCreateConfig object{ allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: optional array of AllowedInferenceGeo or "unrestricted" or null

Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos.

One of the following:
Geos = array of AllowedInferenceGeo
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: optional "global" or "us" or null

Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of allowed_inference_geos unless allowed_inference_geos is "unrestricted".

One of the following:
"global"
"us"
workspace_geo: optional "us" or null

Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.

DataResidencyUpdateConfig object{ allowed_inference_geos, default_inference_geo }
allowed_inference_geos: optional array of AllowedInferenceGeo or "unrestricted" or null

Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.

One of the following:
Geos = array of AllowedInferenceGeo
One of the following:
"global"
"us"
"unrestricted"
default_inference_geo: optional "global" or "us" or null

Default inference geo applied when requests omit the parameter. Must be a member of allowed_inference_geos unless allowed_inference_geos is "unrestricted".

One of the following:
"global"
"us"
KeyProfileMismatchErrorDetails object{ error_code }

The External Key is bound to a user profile, and the Workspace does not have that user profile. A Workspace can use only a key bound to its own user profile or a key that isn't bound to one.

error_code: "key_profile_mismatch"
NoBillingWorkspaceRole = "workspace_admin" or "workspace_developer" or "workspace_restricted_developer" or "workspace_user"
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
Workspace object{ type: "workspace", id, archived_at, 8 more }
WorkspaceMember object{ type: "workspace_member", user_id, workspace_id, workspace_role }
type: "workspace_member"

Object type.

For Workspace Members, this is always "workspace_member".

defaultworkspace_member
user_id: string

ID of the User.

workspace_id: string

ID of the Workspace.

workspace_role: WorkspaceRole

Role of the Workspace Member.

One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
WorkspaceMemberLimitExceededErrorDetails object{ error_code }

The workspace has reached the member limit that Anthropic set for it.

error_code: "workspace_member_limit_exceeded"
WorkspacePolicyField = "external_key_id"
WorkspacePolicyViolationErrorDetails object{ error_code, field }

The request breaks the organization's Workspace Policy. The message says which rule it broke; an organization admin can see and change the policy in the Console.

error_code: "workspace_policy_violation"
field: WorkspacePolicyField

The request field the broken rule applies to.

WorkspaceRole = "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"

WorkspaceLimiti di velocità

Elenca i limiti di velocità del workspace
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Elenca i "rate limit" (limiti di velocità) di un workspace.

Imposta i limiti di velocità del workspace
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

Imposta o rimuovi gli override dei limiti di velocità per un gruppo di limiti di velocità in un workspace.

WorkspaceMembri

Elenca i membri del workspace
GET/v1/organizations/workspaces/{workspace_id}/members
Crea membro del workspace
POST/v1/organizations/workspaces/{workspace_id}/members
Ottieni membro del workspace
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Aggiorna membro del workspace
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Elimina membro del workspace
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

WorkspaceAccount di servizio

Elenca gli account di servizio membri del workspace
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Crea account di servizio membro del workspace
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi API Admin non sono accettate. Consulta Gestire WIF con l'Admin API.

Ottieni account di servizio membro del workspace
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi API Admin non sono accettate. Consulta Gestire WIF con l'Admin API.

Aggiorna account di servizio membro del workspace
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi API Admin non sono accettate. Consulta Gestire WIF con l'Admin API.

Elimina account di servizio membro del workspace
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi API Admin non sono accettate. Consulta Gestire WIF con l'Admin API.