API reference
Get a tool credential
GET /v1/vault/secrets/{secret_id}
One tool credential: its name, last four characters and where it may be used — never its value. Needs vault:write and a key that reaches every project.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
secret_id |
path | string (uuid) | Yes |
Answer
200 with VaultSecretObject.
Errors
Every error is a problem document with a stable code.
| Status | When |
|---|---|
401 |
The key is missing, mistyped, unknown, revoked or expired. |
403 |
The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something. |
404 |
This key reaches no such credential. |
422 |
Validation Error |
429 |
Too many requests for this key or its organization; see Retry-After. |
500 |
Something went wrong on our side. Quote the request_id to support. |
Examples
#!/bin/sh
# Read a tool credential. Never its value.
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/vault/secrets/2e4a6c8e-0a2c-4e4a-d6c8-e0a2c4e6a8ca" \
-H "Authorization: Bearer $AIGENTLY_API_KEY"
Try it
Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.