Set the encryption key
PUT https://app.syntic.ai/v1/organizations/encryption_keyRegister a key in your own KMS to encrypt the organization’s stored content (files, sessions, memory). Syntic first performs a test encrypt and decrypt; grant its service identity, shown in the Console under Settings → Security → Encryption, permission to use the key before calling this.
For how this fits into a full workflow, see Customer-managed keys.
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 |
|---|---|---|---|
provider | string | Yes | gcp, aws or azure. |
key_ref | string | Yes | projects/.../cryptoKeys/..., arn:aws:kms:...:key/... or https://<vault>.vault.azure.net/keys/<name>. |
workspace_ids | array of strings | No | Limit to these workspaces. Default: all. |
reencrypt_existing | boolean | No | Default true: re-encrypt existing content in the background. |
Response
200 OK, Content-Type: application/json
{
"type": "encryption_key",
"provider": "gcp",
"key_ref": "projects/acme-sec/locations/europe-west3/keyRings/syntic/cryptoKeys/content",
"status": "verifying",
"verified_at": null,
"reencryption": {
"status": "queued",
"objects_total": 48211,
"objects_done": 0
}
}Examples
curl -sS -X PUT https://app.syntic.ai/v1/organizations/encryption_key \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: admin-2026-11-01" \
-H "Content-Type: application/json" \
-d '{
"provider": "gcp",
"key_ref": "projects/acme-sec/locations/europe-west3/keyRings/syntic/cryptoKeys/content",
"reencrypt_existing": true
}'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_key_ref | The reference does not match the provider’s format. |
| 400 | invalid_request_error | key_verification_failed | The test encrypt or decrypt failed; check the permissions granted to Syntic. |
| 403 | permission_error | role_required | Only keys created by an Owner may change this. |
| 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. |
If the key becomes unavailable
Features that read or write protected content fail with 503 (encryption_key_unavailable) or 403 (encryption_key_revoked), and an encryption_key.unavailable webhook event is sent. Chat completions is unaffected because it stores nothing. Restoring access resumes normal operation.