Skip to content

List calls

GET/v1/callsNeeds an API key

List your organization's calls, newest first.

Calls are listed without their output; fetch one call to read it. Results are paged: pass the next_cursor of one page as cursor to read the next, until has_more is false. Filter by tool, status or label.

To find the calls of one request, pass its input as JSON with tool, and its provider and require if it had them. A paid result is kept with no time limit, so you can read it again instead of calling again.

Query parameters

limitinteger· default 50

The most calls to return.

From 1 to 100.

cursorstring

The next_cursor of the previous page. Omit to read the first page.

toolstring

Only calls of this tool, by its ID.

statusstring

Only calls with this status.

pending
succeeded
failed
inputstring

Only calls made with exactly this input: the tool's input as a JSON object, URL-encoded. Needs tool. Matched as reuse_within matches a call, with provider and require.

providerstring

With input: only calls that named this provider. Omit for calls that named none.

1 or more characters.

requirearray of string

With input: only calls that required these optional outputs. Repeat for each.

Each item: 1 or more characters.

Repeat for each value.

labelstring

Only calls with this label, matched exactly.

1 to 100 characters.

Response

One page of calls, newest first.

itemsarray of object

This page's items.

items.idstring

The call's ID. Read the call again with GET /v1/calls/{call_id}.

items.toolstring

The tool called.

items.statusstring
pendingWhile providers are tried.
succeededOnce one served the call.
failedWhen none did.
items.failure_reasonstring· nullable

Why a failed call was not served. Null unless the call failed.

all_attempts_failedNo provider served it.
billed_provider_failureThe provider failed the call and billed it, so no other was tried.
rate_limitedEvery provider tried refused it for its rate limit; retry later.
deadline_exceededThe call ran out of time.
internal_errorNo provider served it.
abandonedThe call ran out of time.
items.providerstring· nullable

The provider that served the call. Null unless the call succeeded.

items.requested_providerstring· nullable

The provider the request named in provider. Null when it named none.

items.inputobject

The input as you sent it.

items.resolved_inputobject

The input as the tool read it: case-insensitive values lowercased, defaults filled in, and a page token as its provider issued it.

items.requirearray of string

The optional outputs the request required, by name.

items.costobject· nullable

What the call was charged, in USD. All zeros for a failed call, unless it failed billed_provider_failure. Null while the call is pending.

items.cost.provider_usdstring

The data provider's part of total_usd.

items.cost.platform_fee_usdstring

Voxoria's part of total_usd.

items.cost.total_usdstring

What the call cost you, drawn from your balance: the sum of the other two.

items.labelstring· nullable

The name you gave the call. Null when it has none.

items.created_atstring

When the call was made.

Format date-time.

items.completed_atstring· nullable

When the call succeeded or failed. Null while it is pending.

Format date-time.

next_cursorstring· nullable

Pass as cursor to read the next page. Null on the last page.

has_moreboolean

Whether another page follows.