Create Workspace
api/admin/workspaces/create
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/workspaces/create Changed · +18 / -23 lines
# Create Workspace ## Headers ## Body parameters ## Returns ## Example ### Response (200) ## Create Workspace ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
---- -title: Create Workspace -url: https://platform.claude.com/docs/en/api/admin/workspaces/create ---- +# Create Workspace -## Create Workspace +**POST** `/v1/organizations/workspaces` -**post** `/v1/organizations/workspaces` - Create Workspace -### Header Parameters +## Headers - `"anthropic-beta": optional array of string`
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. -### Body Parameters +## Body parameters - `name: string` Name of the Workspace. -- `data_residency: optional object { allowed_inference_geos, default_inference_geo, workspace_geo } or null` + maxLength: 40, minLength: 1 +- `data_residency: optional object or null` + Data residency configuration for the workspace. If omitted, defaults to workspace_geo=`"us"`, allowed_inference_geos=`"unrestricted"`, and default_inference_geo=`"global"`. - `allowed_inference_geos: optional array of "global" or "us" or "unrestricted" or null`
- `"unrestricted"` - - `"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"`.
Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted. - - `"us"` - - `external_key_id: optional string or null` ID of the customer-managed encryption key (CMEK) configuration to use for this
User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. -### Returns +## Returns -- `Workspace object { id, archived_at, compartment_id, 7 more }` +- `Workspace object` - `id: string`
RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. + format: date-time + - `compartment_id: string` Identifier for this Workspace's encryption compartment. When you configure a
RFC 3339 datetime string indicating when the Workspace was created. - - `data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }` + format: date-time + - `data_residency: object` + Data residency configuration. - `allowed_inference_geos: array of string or "unrestricted"`
- `"unrestricted"` - - `"unrestricted"` - - `default_inference_geo: string` Default inference geo applied when requests omit the parameter.
For Workspaces, this is always `"workspace"`. - - `"workspace"` + default: workspace -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/organizations/workspaces \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
}' ``` -#### Response +### Response (200) ```json {