Update a workspace

⚠️
Preview — this feature is being built; the design below is the spec.
PATCH https://app.syntic.ai/v1/organizations/workspaces/{workspace_id}

Rename a workspace or change its description, IP allowlist or region (region only while it holds no content).

For how this fits into a full workflow, see Workspaces.

Headers

HeaderRequiredValue
AuthorizationYesBearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys.
syntic-betaYes, while in previewadmin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning.
Content-TypeYesapplication/json

Path parameters

ParameterTypeDescription
workspace_idstringThe workspace id, starting with wrkspc_.

Body parameters

ParameterTypeRequiredNotes
namestringNoNew unique name.
descriptionstringNoUp to 200 characters.
allowed_ipsarray of stringsNoReplaces the list.
data_regionstringNoOnly while the workspace is empty.

Response

200 OK, Content-Type: application/json

{
  "id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
  "type": "workspace",
  "name": "production",
  "description": "Customer-facing traffic.",
  "is_default": false,
  "data_region": "us",
  "allowed_ips": [
    "203.0.113.0/24"
  ],
  "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"
}

Examples

curl -sS -X PATCH https://app.syntic.ai/v1/organizations/workspaces/wrkspc_01JC0A2C4E6G8J0L2N4Q \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "syntic-beta: admin-2026-11-01" \
  -H "Content-Type: application/json" \
  -d '{
      "allowed_ips": [
        "203.0.113.0/24"
      ]
    }'

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
404not_found_errorworkspace_not_foundNo workspace with that id in the organization.
409conflict_errorname_takenThe name is in use.
409conflict_errorregion_change_blockedThe workspace already holds content.
403permission_errorrole_requiredThe admin key’s creator does not have the role this needs.
401authentication_errorinvalid_api_keyThe admin key is missing, unknown, revoked or expired.
403permission_erroradmin_key_requiredAn inference key was used.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?