Archive a workspace
⚠️
Preview — this feature is being built; the design below is the spec.
POST https://app.syntic.ai/v1/organizations/workspaces/{workspace_id}/archiveShut a workspace down safely. Every inference key in it fails at once with 403 workspace_archived, running agent sessions are interrupted and deployments paused. Files, sessions, memory and other data are kept, subject to retention, and come back after unarchiving.
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. |
Path parameters
| Parameter | Type | Description |
|---|---|---|
workspace_id | string | The workspace id, starting with wrkspc_. |
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": [],
"spend_limit_usd": "2000.00",
"rate_limits": [
{
"model": "Amara S1.2",
"requests_per_minute": 800
}
],
"archived_at": "2026-11-06T09:00:00Z",
"created_at": "2026-11-01T09:00:00Z"
}Examples
curl -sS -X POST https://app.syntic.ai/v1/organizations/workspaces/wrkspc_01JC0A2C4E6G8J0L2N4Q/archive \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: admin-2026-11-01"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. |
| 404 | not_found_error | workspace_not_found | No workspace with that id in the organization. |
| 409 | conflict_error | default_workspace | The Default workspace cannot be archived. |
| 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. |
Related
Was this page helpful?