API reference · Agents
Top up, drain or rotate an agent's key from the dashboard
POST/api/account/agents/{id}/{action}Signed in session
action is top_up, drain or rotate_key, with the bodies and answers of /v1/agents/{id}/top_up, /drain and /rotate_key.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The agent's id; self on an agent's own key where the route allows it. |
| action (path)required | string | top_up, drain or rotate_key. One of "top_up", "drain", "rotate_key". |
Request body
application/json, optional
The document names no fields for this body.
Example
{}Answer 200
Done.
| Field | Type | What it is |
|---|---|---|
| object | string | One of "agent". |
| id | integer | |
| name | string | |
| status | string | One of "active", "paused". |
| created | integer | Unix seconds. |
| expires_at | integer or null | |
| expired | boolean | |
| models | array of string or null | |
| max_cost_per_request_micros | integer or null | |
| daily_cap_micros | integer or null | |
| auto_refill | object or null | |
| auto_refill. | integer | Move at least this much per refill. At least 1. |
| auto_refill. | integer | Never refill more than this per UTC day. At least 1. |
| wallet_address | string or null | |
| key | object or null | |
| key. | integer | |
| key. | string | |
| key. | integer or null | |
| balance_micros | integer | Spendable: open holds taken off. |
| held_micros | integer | |
| spent_today_micros | integer | Today's settled spend plus open holds: what the daily cap counts. |
| refilled_today_micros | integer | |
| currency | string | One of "USD". |
| api_key | string | The agent's key, shown this once. |
Errors
- 400OpenAI shaped error.
- 401OpenAI shaped error.
- 402OpenAI shaped error.
- 404OpenAI shaped error.
- 409OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.