--- title: Create Workspace url: https://platform.claude.com/docs/en/api/php/beta/organization/workspaces/create --- # Create Workspace `$client->beta->organization->workspaces->create(string name, ?DataResidencyCreateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?array tags, ?string userProfileID, ?list betas): Workspace` **POST** `/v1/organizations/workspaces` Create Workspace ## Parameters - `name: string` Name of the Workspace. - `dataResidency?: optional DataResidencyCreateConfig` Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. - `displayColor?: optional string` Hex color code representing the Workspace in the Anthropic Console. - `externalKeyID?: optional string` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value for an AWS KMS key is the key's ARN, and your organization's own key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `tags?: optional array` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. - `userProfileID?: optional string` ID of a user profile to attach to the Workspace. Every inference request through the Workspace must then name this user profile; the API rejects a request that names none or a different one. The user profile can't be replaced or removed later; only deleting the user profile clears it. - `betas?: optional list` (header parameter) Optional header to specify the beta version(s) you want to use. ## Returns - `class Workspace` - `"workspace" type` Object type. For Workspaces, this is always `"workspace"`. - `string id` ID of the Workspace. - `?\Datetime archivedAt` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. - `string compartmentID` Identifier for this Workspace's encryption compartment. When you configure an AWS KMS customer-managed encryption key (CMEK) that isn't bound to a user profile, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: your organization's own key is validated against this Workspace's own value when it is attached, so if its key policy uses the compartment condition, add this value to it before attaching the key. - `\Datetime createdAt` RFC 3339 datetime string indicating when the Workspace was created. - `DataResidency dataResidency` Data residency configuration. - `string displayColor` Hex color code representing the Workspace in the Anthropic Console. - `?string externalKeyID` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value for an AWS KMS key is the key's ARN, and your organization's own key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `string name` Name of the Workspace. - `array tags` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. - `?string userProfileID` ID of the user profile attached to the Workspace, or null if it has none. Every inference request through a Workspace that has a user profile must name that profile. ## Example ```php beta->organization->workspaces->create( name: 'x', dataResidency: [ 'allowedInferenceGeos' => 'unrestricted', 'defaultInferenceGeo' => 'global', 'workspaceGeo' => 'us', ], displayColor: '#6C5BB9', externalKeyID: 'ekey_01SDCCSbTxrXDpWc1phhtcfK', tags: ['env' => 'prod', 'team' => 'platform'], userProfileID: 'uprof_01SDCCSbTxrXDpWc1phhtcfK', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], ); var_dump($betaWorkspace); ``` ### Response (200) ```json { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace", "user_profile_id": "uprof_01SDCCSbTxrXDpWc1phhtcfK" } ```