Skip to content

Get a call

GET/v1/calls/{call_id}Needs an API key

Fetch one of your organization's calls by id, with its output.

A call still running has status: "pending" and no output or cost yet. Pass wait (up to 50 seconds) to wait for it to finish instead of reading it again and again: the call is answered as soon as it finishes, or as it is once wait is up.

A failed call has no output, a failure_reason, and a cost of zero, unless it failed billed_provider_failure: then the provider's cost, with no fee. Outputs are kept with no time limit. Pass fields (repeat for each path) and max_items to read a smaller view of a large output; reading a call is free and changes nothing stored.

Path parameters

call_idstringRequired

The call's ID.

Query parameters

fieldsarray of string

Return only these parts of output, as paths from its root: results.title keeps each results row's title; page keeps the whole page block. Blocks no path names are left out; a path the output lacks is ignored. Omit for the whole output.

Each item: 1 to 200 characters.

Repeat for each value.

max_itemsinteger

Return at most this many rows of each list block in output. Lists inside a row are kept whole.

From 1 to 1000.

waitinteger· default 0

Seconds to wait for a call still running to finish, 0 to 50, before answering with it as it is then. 0, the default, answers at once.

From 0 to 50.

Response

The call, as it is once wait is up or it finished.

The body is a call: see the call response for every field, an example and the error bodies.