Create a workspace
⚠️
Preview — this feature is being built; the design below is the spec.
POST https://app.syntic.ai/v1/organizations/workspacesCreate a workspace: a division of the organization with its own keys, resources, limits and data region. The region is fixed once the workspace holds content.
For how this fits into a full workflow, see Workspaces.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys. |
syntic-beta | Yes, while in preview | admin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Content-Type | Yes | application/json |
Idempotency-Key | No | Up to 255 characters. Retrying with the same key within 24 hours returns the first result instead of creating a duplicate. See Idempotency. |
Body parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
name | string | Yes | Unique in the organization, 1 to 40 characters. |
description | string | No | Up to 200 characters. |
data_region | string | No | Default us. See Data residency. |
allowed_ips | array of strings | No | IP allowlist for every key in the workspace. |
Response
201 Created, Content-Type: application/json
{
"id": "wrkspc_01JC5B7D9F1H3K5M7P9R",
"type": "workspace",
"name": "staging",
"description": "Pre-release testing.",
"is_default": false,
"data_region": "us",
"allowed_ips": [],
"spend_limit_usd": null,
"rate_limits": [],
"archived_at": null,
"created_at": "2026-11-01T09:00:00Z"
}Examples
curl -sS https://app.syntic.ai/v1/organizations/workspaces \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: admin-2026-11-01" \
-H "Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69" \
-H "Content-Type: application/json" \
-d '{
"name": "staging",
"description": "Pre-release testing.",
"data_region": "us"
}'Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 400 | invalid_request_error | invalid_name | Empty, too long or disallowed characters. |
| 400 | invalid_request_error | unknown_region | Not an available region. |
| 409 | conflict_error | name_taken | Another workspace has the name. |
| 409 | conflict_error | workspace_limit_reached | 100 active workspaces already exist. |
| 403 | permission_error | role_required | The admin key’s creator does not have the role this needs. |
| 401 | authentication_error | invalid_api_key | The admin key is missing, unknown, revoked or expired. |
| 403 | permission_error | admin_key_required | An inference key was used. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Was this page helpful?