Update residency settings

⚠️

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

PUT https://app.syntic.ai/v1/organizations/data_residency

Set the default region, the regions requests may choose, and per-workspace locks. Changing the storage region of existing data is not automatic: files and memory stores stay where they were created, and the response lists how many objects live outside the new default.

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.
`Content-Type`	Yes	`application/json`

Body parameters

Parameter	Type	Required	Notes
`default_region`	string	Yes
`allowed_regions`	array of strings	Yes	Must include `default_region`.
`workspace_overrides`	array	No	Replaces the whole list.

Response

200 OK, Content-Type: application/json

{
  "type": "data_residency",
  "default_region": "eu",
  "allowed_regions": [
    "eu"
  ],
  "workspace_overrides": [
    {
      "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
      "region": "eu",
      "locked": true
    }
  ],
  "updated_at": "2026-11-05T10:00:00Z",
  "objects_outside_default": {
    "files": 112,
    "memory_stores": 2
  }
}

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.
`objects_outside_default`	object	Existing stored objects in another region.

Examples

curl -sS -X PUT "https://app.syntic.ai/v1/organizations/data_residency" \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "syntic-beta: admin-2026-11-01" \
  -H "Content-Type: application/json" \
  -d '{
      "default_region": "eu",
      "allowed_regions": [
        "eu"
      ],
      "workspace_overrides": [
        {
          "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
          "region": "eu",
          "locked": true
        }
      ]
    }'

import os
 
import requests
 
resp = requests.put(
    "https://app.syntic.ai/v1/organizations/data_residency",
    headers={
        "Authorization": f"Bearer {os.environ['SYNTIC_ADMIN_KEY']}",
        "syntic-beta": "admin-2026-11-01",
    },
    json={
        "default_region": "eu",
        "allowed_regions": [
            "eu"
        ],
        "workspace_overrides": [
            {
                "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
                "region": "eu",
                "locked": True
            }
        ]
    },
    timeout=60,
)
data = resp.json()
if not resp.ok:
    raise RuntimeError(f"{resp.status_code} {data['error']['code']}: {data['error']['message']}")
print(data)

const res = await fetch('https://app.syntic.ai/v1/organizations/data_residency', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.SYNTIC_ADMIN_KEY}`,
    'syntic-beta': 'admin-2026-11-01',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "default_region": "eu",
    "allowed_regions": [
      "eu"
    ],
    "workspace_overrides": [
      {
        "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
        "region": "eu",
        "locked": true
      }
    ]
  }),
})
const text = await res.text()
const data = text ? JSON.parse(text) : null
if (!res.ok) throw new Error(`${res.status} ${data.error.code}: ${data.error.message}`)
console.log(data ?? res.status)

package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)
 
func main() {
	body := strings.NewReader(`{
  "default_region": "eu",
  "allowed_regions": [
    "eu"
  ],
  "workspace_overrides": [
    {
      "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
      "region": "eu",
      "locked": true
    }
  ]
}`)
	req, err := http.NewRequest("PUT", "https://app.syntic.ai/v1/organizations/data_residency", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("SYNTIC_ADMIN_KEY"))
	req.Header.Set("syntic-beta", "admin-2026-11-01")
	req.Header.Set("Content-Type", "application/json")
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, _ := io.ReadAll(resp.Body)
	if resp.StatusCode >= 300 {
		panic(fmt.Sprintf("%d: %s", resp.StatusCode, out))
	}
	fmt.Println(string(out))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "default_region": "eu",
              "allowed_regions": [
                "eu"
              ],
              "workspace_overrides": [
                {
                  "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
                  "region": "eu",
                  "locked": true
                }
              ]
            }
            """;
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://app.syntic.ai/v1/organizations/data_residency"))
            .header("Authorization", "Bearer " + System.getenv("SYNTIC_ADMIN_KEY"))
            .header("syntic-beta", "admin-2026-11-01")
            .header("Content-Type", "application/json")
            .method("PUT", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 300) {
            throw new RuntimeException(response.statusCode() + ": " + response.body());
        }
        System.out.println(response.body());
    }
}

using System.Net.Http.Headers;
using System.Text;
 
using var http = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("PUT"), "https://app.syntic.ai/v1/organizations/data_residency");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("SYNTIC_ADMIN_KEY"));
request.Headers.Add("syntic-beta", "admin-2026-11-01");
request.Content = new StringContent("""
    {
      "default_region": "eu",
      "allowed_regions": [
        "eu"
      ],
      "workspace_overrides": [
        {
          "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
          "region": "eu",
          "locked": true
        }
      ]
    }
    """, Encoding.UTF8, "application/json");
 
using var response = await http.SendAsync(request);
var text = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode) throw new Exception($"{(int)response.StatusCode}: {text}");
Console.WriteLine(text);

<?php
$body = <<<'JSON'
{
  "default_region": "eu",
  "allowed_regions": [
    "eu"
  ],
  "workspace_overrides": [
    {
      "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
      "region": "eu",
      "locked": true
    }
  ]
}
JSON;
 
$ch = curl_init('https://app.syntic.ai/v1/organizations/data_residency');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('SYNTIC_ADMIN_KEY'),
        'syntic-beta: admin-2026-11-01',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);
 
if ($status >= 300) {
    throw new RuntimeException("$status: $response");
}
print_r(json_decode($response, true) ?? $status);

require "json"
require "net/http"
require "uri"
 
uri = URI("https://app.syntic.ai/v1/organizations/data_residency")
req = Net::HTTP::Put.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch('SYNTIC_ADMIN_KEY')}"
req["syntic-beta"] = "admin-2026-11-01"
req["Content-Type"] = "application/json"
req.body = <<~'JSON'
  {
    "default_region": "eu",
    "allowed_regions": [
      "eu"
    ],
    "workspace_overrides": [
      {
        "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
        "region": "eu",
        "locked": true
      }
    ]
  }
JSON
 
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
raise "#{res.code}: #{res.body}" unless res.is_a?(Net::HTTPSuccess)
puts res.body.empty? ? res.code : JSON.pretty_generate(JSON.parse(res.body))

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`	`region_not_available`	The region is not offered for your plan or for a model your workspaces pin.
403	`permission_error`	`owner_required`	Only owners can change residency.
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.

Get settings Get settings

Was this page helpful?