Skip to navigation
Audio Decisions APIRuns

List runs

Your organization’s runs, newest first, one page at a time. The filters combine.

A run is one model inference. A successful decisions request is recorded as a run, which can take a moment to appear in this list, and under heavy load may not be recorded. A decisions request that fails before its input reaches the model, including every request rejected with a 4xx status, has none.

Authentication

X-Hume-Api-Keystring
API Key authentication via header

Query parameters

page_sizeintegerOptional1-200Defaults to 50
How many runs to return.
cursorstringOptional

The next_cursor of the previous page. Pass it back unchanged, with the same filters as the request that returned it.

user_idstringOptional
Only runs made by this user.
statusenumOptional
Only runs with this status.
Allowed values:
started_beforedatetimeOptional
Only runs that started before this time, in RFC 3339 format.
started_afterdatetimeOptional
Only runs that started at or after this time, in RFC 3339 format. Consecutive time ranges that share a boundary neither skip a run nor return one twice.

Response

One page of runs.
runslist of objects
The runs, newest first.
run_idstringformat: "uuid"

The run’s ID: the run_id of a decisions response.

user_idstring
The ID of the Hume user who made the run.
statusenum

How a run ended: ended if it returned answers, and errored if it returned none because inference failed or the client closed the connection first.

Allowed values:
started_atdatetime
When the run started.
ended_atdatetime
When the run ended.
receivedobject

The file part a run received, and the input tokens it was billed.

next_cursorstringOptional

Absent on the last page. Pass it back as cursor for the next one.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error