Wallet
What is in the API wallet (the person's for a personal key, the organization's for its keys), what running calls hold, and what is free for a new paid call. For a personal key, the person's plan and this week's minutes: with a paid plan and spend_from set to plan_then_wallet, sending audio uses those minutes first. And what this key spent this week against its cap. Test keys see the same wallet; their calls never spend from it.
Authorization
apiKey Authorization: Bearer taad_… (or taadtest_… for the sandbox). Never in a URL, never in a web page.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/usage"{ "object": "usage", "wallet": { "balance_usd": 0, "held_usd": 0, "available_usd": 0 }, "plan": { "name": "individual", "minutes": 0, "used": 0, "held": 0, "left": 0, "week_starts_at": "string", "resets_at": "string" }, "spend_from": "plan_then_wallet", "key": { "id": "string", "spent_this_week_usd": 0, "held_usd": 0, "weekly_cap_usd": 0, "cap_left_usd": 0, "resets_at": "string" }}What each paid call costs, in US dollars, and what a normal call of that size costs us. A call that costs us more than a normal one (a recording full of overlapping voices, a long question) is charged that difference too, at our cost, never multiplied. No key needed.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/prices"{ "object": "price_list", "currency": "usd", "data": [ { "object": "price", "id": "audio", "description": "string", "unit": "hour", "price_usd": 0, "normal_cost_usd": 0 } ], "extra_at_cost": "string", "free": "string", "max_file_hours": 0}The wallet's ledger, newest first: top-ups, refunds, charges (each says what for) and adjustments. The balance is their sum.
Authorization
apiKey Authorization: Bearer taad_… (or taadtest_… for the sandbox). Never in a URL, never in a web page.
In: header
Query Parameters
1 <= value <= 10020length <= 500Value in
- "top_up"
- "refund"
- "charge"
- "adjustment"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/wallet/entries"{ "object": "list", "data": [ { "id": "string", "object": "wallet_entry", "kind": "top_up", "amount_usd": 0, "description": "string", "key_id": "string", "created_at": "string" } ], "has_more": true, "next_cursor": "string"}