API reference · Agents
Move an agent's money back to the account
POST/v1/agents/{id}/drainAPI key
amount_micros, or with an empty body everything the agent can spend.
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. |
Request body
application/json, optional
| Field | Type | What it is |
|---|---|---|
| amount_micros | integer | Micro USD: a dollar is 1000000. At least 1. |
Example
{
"amount_micros": 1
}Answer 200
Moved.
| 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". |
| returned_micros | integer |
Errors
- 400OpenAI shaped error.
- 401OpenAI shaped error.
- 403OpenAI 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.