Skip to main content
GET
/
api
/
v2
/
vaults
/
{vault_id}
/
health
Check health
curl --request GET \
  --url https://agp.eu.hcompany.ai/api/v2/vaults/{vault_id}/health \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "error": {}
}
Probes the provider behind a vault config to confirm the stored token still works. Use it before a run that depends on the vault, since a token can be revoked or expire on the provider side. The endpoint returns 200 whenever the provider is reachable, so branch on the ok field, not the HTTP status. Returns a health object with ok and an optional error.

​
Path parameters

​
vault_id
string
required
The vault config’s id (UUID).

​
Response

​
ok
boolean
true if the provider accepted the stored token and the vault is reachable.
​
error
string | null
Short reason when ok is false; null otherwise.

​
Examples

curl "https://agp.eu.hcompany.ai/api/v2/vaults/f47ac10b-58cc-4372-a567-0e02b2c3d479/health" \
  -H "Authorization: Bearer $HAI_API_KEY"
Response
{
  "ok": true,
  "error": null
}

​
Errors

StatusCause
404Vault not found or you don’t have access.