For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Start buildingGet support
DocumentationAPI ReferenceChangelogDiscord
  • Voices
    • POSTCreate voice
    • GETList voices
    • DELDelete voice
  • Text-to-Speech (TTS)
    • WSSStream Input
    • STREAMText-to-Speech (Streamed JSON)
    • POSTText-to-Speech (Streamed File)
    • POSTText-to-Speech (Json)
    • POSTText-to-Speech (File)
    • POSTVoice Conversion (Streamed File)
    • STREAMVoice Conversion (Streamed JSON)
  • Speech-to-speech (EVI)
    • WSSChat
  • Expression Measurement API
      • GETList jobs
      • POSTStart inference job
      • GETGet job details
      • GETGet job predictions
      • GETGet job artifacts
      • POSTStart inference job from local file
Start buildingGet support
LogoLogo
LogoLogo
Expression Measurement APIBatch

Start inference job

POST
https://api.hume.ai/v0/batch/jobs
POST
/v0/batch/jobs
$curl -X POST https://api.hume.ai/v0/batch/jobs \
>     -H "X-Hume-Api-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "urls": [
>    "https://hume-tutorials.s3.amazonaws.com/faces.zip"
>  ],
>  "notify": true
>}'
200Successful
1{
2  "job_id": "job_id"
3}
Start a new measurement inference job.
Was this page helpful?
Previous

Get job details

Next
Built with

Authentication

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

Request

This endpoint expects an object.
modelsobjectOptional
Specify the models to use for inference. If this field is not explicitly set, then all models will run by default.
transcriptionobjectOptional
urlslist of stringsOptional

URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (.zip, .tar.gz, .tar.bz2, .tar.xz) of media files.

If you wish to supply more than 100 URLs, consider providing them as an archive (.zip, .tar.gz, .tar.bz2, .tar.xz).

textlist of stringsOptional
Text supplied directly to our Emotional Language and NER models for analysis.
callback_urlstringOptionalformat: "url"

If provided, a POST request will be made to the URL with the generated predictions on completion or the error message on failure.

notifybooleanOptionalDefaults to false

Whether to send an email notification to the user upon job completion/failure.

Response

job_idstringformat: "uuid"
The ID of the started job.