List API keys
Paginate the workspace’s inference keys, including disabled keys when requested.
Last updated on
GET /v1/keys
List inference keys in the management key’s workspace. Management keys are not included.
Authentication
Authorization: Bearer <MANAGEMENT_API_KEY>: a management key bound to the workspace. The key owner must retain the live permission apiKeys.read.
The credential determines the workspace. X-Org-Id is unsupported.
Query parameters
| Field | Type | Description |
|---|---|---|
offset | integer | 0–1000000; default 0. |
limit | integer | 1–100; default 100. |
include_disabled | string | true / false; default false. Include disabled keys. |
workspace_id | string | Optional assertion of the current workspace, not a selector. |
Increase offset by limit until a short or empty page is returned. There is no total or next_cursor field.
Response · 200
| Field | Type | Description |
|---|---|---|
data | object[] | Array of key objects. |
Each key includes the current-key fields plus:
| Field | Type | Description |
|---|---|---|
hash | string | SHA-256 locator used in the path. |
name | string | Key name. |
disabled | boolean | Whether new inference requests are blocked. |
created_at | string (date-time) | Creation timestamp. |
updated_at, last_used_at | string | null | ISO timestamps or null when unavailable. |
With multiple limits, limit, limit_reset and limit_remaining are null; read spend_limits. is_management_key is always false.
Response example
Identifiers and amounts in these examples are illustrative.
Request example
Load the key into a server environment variable. TypeScript uses Node.js fetch; Python uses only the standard library.
const response = await fetch("https://api.provod.ai/v1/keys?offset=0&limit=100&include_disabled=true", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.MANAGEMENT_API_KEY}`,
},
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());Errors
| HTTP | Error | Cause |
|---|---|---|
401 | Unauthorized | Missing, invalid, disabled, revoked or expired key. The X-Org-Id header is also rejected. |
403 | Forbidden | Wrong key kind or insufficient workspace access. |
400 | Bad Request | Invalid or unknown parameters. |
Authentication error example:
{
"error": {
"code": "invalid_api_key",
"message": "Invalid API key",
"metadata": {}
}
}