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

List jobs

GET
https://api.hume.ai/v0/batch/jobs
GET
/v0/batch/jobs
$curl https://api.hume.ai/v0/batch/jobs \
>     -H "X-Hume-Api-Key: <apiKey>"
200Retrieved
1[
2  {
3    "job_id": "job_id",
4    "request": {
5      "callback_url": null,
6      "files": [
7        {
8          "filename": "filename",
9          "md5sum": "md5sum",
10          "content_type": "content_type"
11        }
12      ],
13      "models": {
14        "burst": {},
15        "face": {
16          "descriptions": null,
17          "facs": null,
18          "fps_pred": 3,
19          "identify_faces": false,
20          "min_face_size": 60,
21          "prob_threshold": 0.99,
22          "save_faces": false
23        },
24        "facemesh": {},
25        "language": {
26          "granularity": "word",
27          "identify_speakers": false,
28          "sentiment": null,
29          "toxicity": null
30        },
31        "ner": {
32          "identify_speakers": false
33        },
34        "prosody": {
35          "granularity": "utterance",
36          "identify_speakers": false,
37          "window": null
38        }
39      },
40      "notify": true,
41      "text": [],
42      "urls": [
43        "https://hume-tutorials.s3.amazonaws.com/faces.zip"
44      ]
45    },
46    "state": {
47      "created_timestamp_ms": 1712587158717,
48      "ended_timestamp_ms": 1712587159274,
49      "num_errors": 0,
50      "num_predictions": 10,
51      "started_timestamp_ms": 1712587158800,
52      "status": "COMPLETED"
53    },
54    "type": "INFERENCE"
55  }
56]
Sort and filter jobs.
Was this page helpful?
Previous

Start inference job

Next
Built with

Authentication

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

Query parameters

limitintegerOptionalDefaults to 50
The maximum number of jobs to include in the response.
statuslist of enumsOptional

Include only jobs of this status in the response. There are four possible statuses:

  • QUEUED: The job has been received and is waiting to be processed.

  • IN_PROGRESS: The job is currently being processed.

  • COMPLETED: The job has finished processing.

  • FAILED: The job encountered an error and could not be completed successfully.

Allowed values:
whenobjectOptional

Specify whether to include jobs created before or after a given timestamp_ms.

timestamp_mslongOptionalDefaults to 1704319392247

Provide a timestamp in milliseconds to filter jobs.

When combined with the when parameter, you can filter jobs before or after the given timestamp. Defaults to the current Unix timestamp if one is not provided.

sort_byobjectOptional

Specify which timestamp to sort the jobs by.

  • created: Sort jobs by the time of creation, indicated by created_timestamp_ms.

  • started: Sort jobs by the time processing started, indicated by started_timestamp_ms.

  • ended: Sort jobs by the time processing ended, indicated by ended_timestamp_ms.

directionobjectOptional

Specify the order in which to sort the jobs. Defaults to descending order.

  • asc: Sort in ascending order (chronological, with the oldest records first).

  • desc: Sort in descending order (reverse-chronological, with the newest records first).

Response

UnionJob_Job<Inference>object