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

Get job details

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

Get job predictions

Next
Built with

Authentication

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

Path parameters

idstringRequiredformat: "uuid"
The unique identifier for the job.

Response

UnionJob_Job<Inference>object