Workspace

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/anthropic/main/json-schema/anthropic-beta-workspace-schema.json",
  "title": "Workspace",
  "x-generated": "2026-09-23",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/anthropic-organizations-api-openapi.yml#/components/schemas/BetaWorkspace",
  "properties": {
    "archived_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Archived At",
      "description": "RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived."
    },
    "compartment_id": {
      "type": "string",
      "title": "Compartment Id",
      "description": "Identifier for this Workspace's encryption compartment. When you configure a\ncustomer-managed encryption key (CMEK) on AWS, reference this value in your\nKMS key-policy condition so the key is scoped to this compartment. On GCP and\nAzure, Anthropic enforces the compartment binding automatically; you do not\nneed to reference this value in your key configuration. See the CMEK integration guide for the\nrequired key configuration, including the value used during key validation."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "Created At",
      "description": "RFC 3339 datetime string indicating when the Workspace was created."
    },
    "data_residency": {
      "$ref": "#/$defs/BetaDataResidency",
      "description": "Data residency configuration."
    },
    "display_color": {
      "type": "string",
      "title": "Display Color",
      "description": "Hex color code representing the Workspace in the Anthropic Console."
    },
    "external_key_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "External Key Id",
      "description": "ID of the customer-managed encryption key (CMEK) configuration to use for this\nWorkspace. Setting this field requires CMEK to be enabled for your\norganization. When set, data stored for this Workspace is encrypted with the\nreferenced key. Create key configurations with the External Keys API. This\nfield is write-once: once a key is attached to a Workspace it cannot be\ndetached or replaced. To rotate key material, rotate the underlying key on\nyour cloud KMS; the `external_key_id` stays the same."
    },
    "id": {
      "type": "string",
      "title": "Id",
      "description": "ID of the Workspace."
    },
    "name": {
      "type": "string",
      "title": "Name",
      "description": "Name of the Workspace."
    },
    "tags": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "title": "Tags",
      "description": "User-defined tags as string key-value pairs. Keys may not begin with `anthropic`."
    },
    "type": {
      "type": "string",
      "const": "workspace",
      "title": "Type",
      "description": "Object type.\n\nFor Workspaces, this is always `\"workspace\"`.",
      "default": "workspace"
    }
  },
  "type": "object",
  "required": [
    "archived_at",
    "compartment_id",
    "created_at",
    "data_residency",
    "display_color",
    "external_key_id",
    "id",
    "name",
    "tags",
    "type"
  ],
  "$defs": {
    "BetaDataResidency": {
      "properties": {
        "allowed_inference_geos": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array",
              "x-stainless-variantName": "geos"
            },
            {
              "type": "string",
              "const": "unrestricted",
              "title": "UnrestrictedAllowedInferenceGeos",
              "x-stainless-variantName": "unrestricted"
            }
          ],
          "title": "Allowed Inference Geos",
          "description": "Permitted inference geo values. 'unrestricted' means all geos are allowed."
        },
        "default_inference_geo": {
          "type": "string",
          "title": "Default Inference Geo",
          "description": "Default inference geo applied when requests omit the parameter."
        },
        "workspace_geo": {
          "type": "string",
          "title": "Workspace Geo",
          "description": "Geographic region for workspace data storage. Immutable after creation."
        }
      },
      "type": "object",
      "required": [
        "allowed_inference_geos",
        "default_inference_geo",
        "workspace_geo"
      ],
      "title": "DataResidency"
    }
  }
}