Get a vault
⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/vaults/{vault_id}Return a vault and its secrets’ metadata: name, last-four hint, allowed destinations and last use. No endpoint ever returns a secret’s value.
For how this fits into a full workflow, see Credential vaults.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <key>: a private inference key (sk_live_...). See Authentication. |
syntic-beta | Yes, while in preview | agents-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Path parameters
| Parameter | Type | Description |
|---|---|---|
vault_id | string | The vault id, starting with vlt_. |
Response
200 OK, Content-Type: application/json
{
"id": "vlt_01JC2B4D6F8H0K2M4P6R",
"type": "vault",
"name": "acme-prod",
"description": "Production credentials for the Acme integration.",
"secrets": [
{
"name": "crm-token",
"hint": "…9f2a",
"allowed_destinations": [
"mcp.example.com"
],
"created_at": "2026-11-03T09:00:00Z",
"updated_at": "2026-11-05T09:00:00Z",
"last_used_at": "2026-11-05T10:00:03Z"
}
],
"created_at": "2026-11-03T09:00:00Z"
}| Field | Type | Description |
|---|---|---|
secrets[].name | string | How agents and configuration refer to the secret. |
secrets[].hint | string | Last four characters; omitted for values under 16 characters. |
secrets[].allowed_destinations | array | Hosts the value may be sent to. Empty means unrestricted. |
secrets[].last_used_at | string or null | Last time a tool used it. |
Examples
curl -sS https://app.syntic.ai/v1/vaults/vlt_01JC2B4D6F8H0K2M4P6R \
-H "Authorization: Bearer $SYNTIC_API_KEY" \
-H "syntic-beta: agents-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 | vault_not_found | No vault with that id in this workspace. |
| 401 | authentication_error | invalid_api_key | The key is missing, unknown, revoked or expired. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Related
Was this page helpful?