Get residency settings
⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/organizations/data_residencyReturn where the organization’s requests are processed and its data stored.
For how this fits into a full workflow, see Data residency.
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. |
Response
200 OK, Content-Type: application/json
{
"type": "data_residency",
"default_region": "eu",
"allowed_regions": [
"eu",
"us"
],
"workspace_overrides": [
{
"workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
"region": "eu",
"locked": true
}
],
"updated_at": "2026-11-05T10:00:00Z"
}| Field | Type | Description |
|---|---|---|
default_region | string | us, eu or global. Where requests without a region are processed and where files, batches and agent data are stored. |
allowed_regions | array | Regions a request may ask for with the per-request region field. A request for any other region is refused. |
workspace_overrides | array | Per-workspace region; locked stops requests in that workspace from choosing another region. |
Examples
curl -sS "https://app.syntic.ai/v1/organizations/data_residency" \
-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. |
| 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?