Expression Measurement API

Every endpoint, parameter, field, and message of the Expression Measurement API.

The API is currently in limited release; contact our team to request access.

This reference lists every endpoint of the Expression Measurement API, with the parameters, fields, and messages each one accepts and returns. To learn how the endpoints fit together, start with the overview.

Base URLs

ProtocolBase URL
HTTPhttps://api.cloud.hume.ai
WebSocketwss://api.cloud.hume.ai

Authentication

Every request carries a credential header: an API key in X-Hume-Api-Key, or an access token in Authorization: Bearer <token>. On a realtime endpoint, the header goes on the handshake request that opens the WebSocket. See Authentication.

Endpoints

EndpointDescription
WSS /v1/expression/audio/realtimeStream audio and receive measurements for each utterance.
POST /v1/expression/audio/fileUpload an audio file and receive measurements for every utterance.
WSS /v1/expression/video/realtimeStream video as JPEG frames and receive scores for the faces in each frame.
POST /v1/expression/video/fileUpload JPEG images and receive scores for the faces in each image.
GET /v1/expression/runPaginated list of your organization’s runs.
GET /v1/expression/run/{run_id}One run: its status and configuration.
GET /v1/expression/run/{run_id}/eventsThe problems the run reported, in order.

Errors

The upload and run endpoints return an HTTP error response, and realtime sessions send an error message. Both carry a code to branch on and a message for people to read. See Errors.

SDKs