Skip to navigation

Get run

The run's status, when it started and ended, the audio it received, and the request it evaluated. The run does not include the answers.

Authentication

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

Path parameters

run_idstringRequiredformat: "uuid"

The run’s ID: the run_id of a decisions response. An ID that is not a UUID returns 404, as an unknown one does.

Response

The run.
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.

file_bytesinteger>=0

The size of the file part as sent, in bytes.

input_tokensintegerOptional>=0

The input tokens the run was billed: the decisions response’s received.input_tokens. Absent for a run that was not billed.

requestobject

The request part the run evaluated: its context and questions, as sent.

questionsmap from strings to objects

The questions to answer: at most 20 noul, choice and score questions together, and at most 5 span questions. Each key is a question ID you choose, such as agent_tone, and can be any non-empty string of up to 256 characters. The response returns each answer under the same ID.

contextstringOptional<=1000 characters
Background information the model considers alongside the audio, such as the setting or who is speaking.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error