The workspace object

⚠️

Preview — this feature is being built; the design below is the spec.

The workspace object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
  "type": "workspace",
  "name": "production",
  "description": "Customer-facing traffic.",
  "is_default": false,
  "data_region": "us",
  "allowed_ips": [],
  "spend_limit_usd": "2000.00",
  "rate_limits": [
    {
      "model": "Amara S1.2",
      "requests_per_minute": 800
    }
  ],
  "archived_at": null,
  "created_at": "2026-11-01T09:00:00Z"
}

Fields

Field	Type	Description
`id`	string	Unique id of this object.
`type`	string	The object type, always `workspace`.
`name`	string	Name shown in the Console and in reports.
`description`	string	Free-text description.
`is_default`	boolean	`true` for the Default workspace, which cannot be archived.
`data_region`	string	Where its content is processed and stored.
`allowed_ips`	array	Nested detail; see the endpoint pages below.
`spend_limit_usd`	string or null	Monthly credit cap, managed with Spend limits.
`rate_limits`	array	Per-model caps, managed with Set workspace rate limits.
`archived_at`	string or null	When it was archived.
`created_at`	string	When it was created, RFC 3339 UTC (some older objects use Unix seconds).

Returned by

webhook workspace_member

Was this page helpful?