Claude Platform Docs

Espaces de travail

Lister les espaces de travail
GET/v1/organizations/workspaces
Créer un espace de travail
POST/v1/organizations/workspaces
Obtenir un espace de travail
GET/v1/organizations/workspaces/{workspace_id}
Mettre à jour un espace de travail
POST/v1/organizations/workspaces/{workspace_id}
Archiver un espace de travail
POST/v1/organizations/workspaces/{workspace_id}/archive
Models
BetaAllowedInferenceGeo = "global" or "us"
One of the following:
"global"
"us"
BetaDataResidency object{ allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: array of BetaAllowedInferenceGeo or "unrestricted"

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

One of the following:
Geos = array of BetaAllowedInferenceGeo
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.

BetaDataResidencyCreateConfig object{ allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: optional array of BetaAllowedInferenceGeo 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 BetaAllowedInferenceGeo
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.

BetaDataResidencyUpdateConfig object{ allowed_inference_geos, default_inference_geo }
allowed_inference_geos: optional array of BetaAllowedInferenceGeo 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 BetaAllowedInferenceGeo
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"
BetaNoBillingWorkspaceRole = "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"
BetaWorkspace object{ type: "workspace", id, archived_at, 7 more }
BetaWorkspaceMember 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: BetaWorkspaceRole

Role of the Workspace Member.

One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
BetaWorkspaceRole = "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"

Espaces de travailLimites de débit

Lister les limites de débit d'un espace de travail
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Listez les « rate limits » (limites de débit) d'un espace de travail.

Définir les limites de débit d'un espace de travail
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

Définit ou efface les surcharges de limites de débit pour un groupe de limites de débit dans un espace de travail.

Espaces de travailMembres

Lister les membres d'un espace de travail
GET/v1/organizations/workspaces/{workspace_id}/members
Créer un membre d'espace de travail
POST/v1/organizations/workspaces/{workspace_id}/members
Obtenir un membre d'espace de travail
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Mettre à jour un membre d'espace de travail
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Supprimer un membre d'espace de travail
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Espaces de travailComptes de service

Lister les comptes de service membres d'un espace de travail
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Créer un compte de service membre d'un espace de travail
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Obtenir un compte de service membre d'un espace de travail
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Mettre à jour un compte de service membre d'un espace de travail
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Supprimer un compte de service membre d'un espace de travail
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés API Admin ne sont pas acceptées. Consultez Gérer WIF avec l'API Admin.