Expression Measurement APIRuns

Get run

The run's status, when it started and ended, what it received and stored, and the configuration it ran under.

Authentication

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

Path parameters

run_idstringRequiredformat: "uuid"

The run’s ID: the session_id of a realtime session or the run_id of a file response.

Response

The run.
run_idstringformat: "uuid"

The run’s ID: the session_id of a realtime session, or the run_id of a file response.

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

Where a run is in its life: live while it is in progress, ended once it completed, and errored if it ended because of a failure or because the connection was lost. A live run the server has not heard from in five minutes is also reported errored, and reads live again if the server hears from it.

Allowed values:
endpointenum
What the run measured.
Allowed values:
modeenum
How the media reached the API.
Allowed values:
started_atdatetime
When the run started.
ended_atdatetime or null

When the run ended. Null while it is in progress. For a run reported errored because the server stopped hearing from it, the last time the server heard from it.

close_codeinteger or null

The WebSocket close code the session ended with, or 1011 if the connection was lost without a close frame. Only realtime runs that have ended have one, and not all of those: it is absent when the client’s close frame carried no code, or when the server stopped before recording how the session closed.

close_reasonstring or null

Why the session closed: client_request, server_shutdown, idle_timeout or error when the server closed it, error when the connection was lost without a close frame, and otherwise the reason text from the client’s close frame. Only realtime runs that have ended have one, and not all of those: it is absent when the client’s close frame carried no code, or when the server stopped before recording how the session closed.

bytes_receivedinteger or null

Bytes of media the server took in. A realtime video frame counts once it passes the send-rate check, even if it is then rejected as invalid. Null until the run ends, and for a run whose end was never recorded.

bytes_recordedinteger or null
How far the server got in storing the run's media, in bytes. Media that could not be stored is included, so this can exceed what was kept. Null when the run's media was not being stored, or when the server has not reported how much it stored, as early in a live run.
metered_secondsdouble>=0

Billable seconds for the run. For audio, this is the duration of the audio the server took in. For video, each frame or image the server took in counts as one third of a second, regardless of frame rate, including a realtime frame rejected as invalid after it passed the send-rate check. A run that took in any media is billed at least 10 seconds, applied when the run ends. Updated while a realtime run is in progress. A file request that fails is not billed, and a run recorded for it reports 0.

configobject
The configuration the run ran under, including defaults for any settings the request did not set.
Audio run configurationobject
The configuration an audio run ran under.
OR
Video run configurationobject
The configuration a video run ran under.

Errors

401
Unauthorized Error
404
Not Found Error
405
Method Not Allowed Error
500
Internal Server Error
503
Service Unavailable Error