Claude Platform Docs

Create Workspace

beta.organization.workspaces.create(**kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces

Create Workspace

Parameters
name: String

Name of the Workspace.

minLength1
maxLength255
data_residency: optional BetaDataResidencyCreateConfig { allowed_inference_geos, default_inference_geo, workspace_geo } | nil

Data residency configuration for the workspace. If omitted, defaults to workspace_geo: "us", allowed_inference_geos: "unrestricted", and default_inference_geo: "global".

display_color: optional String | nil

Hex color code representing the Workspace in the Anthropic Console.

maxLength7
pattern^#[0-9A-Fa-f]{6}$
external_key_id: optional String | nil

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 Hash[Symbol, String] | nil

User-defined tags as string key-value pairs. Keys may not begin with anthropic.

user_profile_id: optional String | nil

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 Array[AnthropicBeta]⁠Header parameter

Optional header to specify the beta version(s) you want to use.

One of the following:
String = String
:"message-batches-2024-09-24"
:"prompt-caching-2024-07-31"
:"computer-use-2024-10-22"
:"computer-use-2025-01-24"
:"pdfs-2024-09-25"
:"token-counting-2024-11-01"
:"token-efficient-tools-2025-02-19"
:"output-128k-2025-02-19"
:"files-api-2025-04-14"
:"mcp-client-2025-04-04"
:"mcp-client-2025-11-20"
:"dev-full-thinking-2025-05-14"
:"interleaved-thinking-2025-05-14"
:"code-execution-2025-05-22"
:"extended-cache-ttl-2025-04-11"
:"context-1m-2025-08-07"
:"context-management-2025-06-27"
:"model-context-window-exceeded-2025-08-26"
:"skills-2025-10-02"
:"fast-mode-2026-02-01"
:"output-300k-2026-03-24"
:"user-profiles-2026-03-24"
:"user-profiles-2026-08-18"
:"user-profiles-2026-09-04"
:"advisor-tool-2026-03-01"
:"managed-agents-2026-04-01"
:"cache-diagnosis-2026-04-07"
:"dreaming-2026-04-21"
:"thinking-token-count-2026-05-13"
:"server-side-fallback-2026-06-01"
:"server-side-fallback-2026-07-01"
:"fallback-credit-2026-06-01"
:"fallback-credit-2026-07-01"
:"agent-memory-2026-07-22"
:"mid-conversation-tool-changes-2026-07-01"
:"compact-2026-01-12"
:"computer-use-2025-11-24"
:"mcp-tunnels-2026-06-22"
:"structured-outputs-2025-11-13"
:"task-budgets-2026-03-13"
:"thinking-display-updates-2026-08-18"
:"ce-user-management-2026-07-13"
:"mid-conversation-output-config-2026-07-01"
:"thinking-binding-controls-2026-08-01"
:"mid-conversation-system-clear-at-2026-08-21"
:"compact-2026-09-04"
:"inline-tools-2026-09-15"
:"mcp-client-2026-09-15"
:"ce-plugins-2026-09-01"
:"spend-limit-reads-2026-09-26"
:"telemetry-destinations-2026-08-11"
:"webhooks-2026-10-07"
:"admin-user-sign-out-2026-10-08"
:"message-threads-2026-08-12"
:"analytics-usage-cost-2026-08-24"
:"experimental-claude-tag-2026-10-21"
Returns
class BetaWorkspace { type: :workspace, id, archived_at, 8 more }
Create Workspace
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

beta_workspace = anthropic.beta.organization.workspaces.create(name: "x")

puts(beta_workspace)
Returns Examples
Response 200
{
  "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"
}