Batch

List jobs

GET
Sort and filter jobs.

Query parameters

limitintegerOptional
The maximum number of jobs to include in the response.
statusenumOptional
Include only jobs with these statuses.
Allowed values: QUEUEDIN_PROGRESSCOMPLETEDFAILED
whenenumOptional

Include only jobs that were created before or after timestamp_ms.

Allowed values: created_beforecreated_after
timestamp_msintegerOptional

Defaults to the current date and time. See when.

sort_byenumOptional
The job timestamp to sort by.
Allowed values: createdstartedended
directionenumOptional
The sort direction.
Allowed values: ascdesc
typeenumOptional
Include only jobs of these types.
Allowed values: EMBEDDING_GENERATIONINFERENCETL_INFERENCETRAINING

Response

This endpoint returns a list of unions
Embedding Generation
OR
Inference
OR
Tl Inference
OR
Training
GET
1curl https://api.hume.ai/v0/batch/jobs \
2 -H "X-Hume-Api-Key: <apiKey>"
200Retrieved
1[
2 {
3 "type": "INFERENCE",
4 "job_id": "job_id",
5 "request": {
6 "files": [
7 {
8 "md5sum": "md5sum",
9 "filename": "filename",
10 "content_type": "content_type"
11 }
12 ],
13 "models": {
14 "face": {
15 "fps_pred": 3,
16 "prob_threshold": 0.99,
17 "identify_faces": false,
18 "min_face_size": 60,
19 "save_faces": false
20 },
21 "burst": {},
22 "prosody": {
23 "granularity": "utterance",
24 "identify_speakers": false
25 },
26 "language": {
27 "granularity": "word",
28 "identify_speakers": false
29 },
30 "ner": {
31 "identify_speakers": false
32 },
33 "facemesh": {}
34 },
35 "urls": [
36 "https://hume-tutorials.s3.amazonaws.com/faces.zip"
37 ],
38 "registry_files": [],
39 "text": [],
40 "notify": true
41 },
42 "state": {
43 "status": "COMPLETED",
44 "created_timestamp_ms": 1712587158717,
45 "ended_timestamp_ms": 1712587159274,
46 "num_errors": 0,
47 "num_predictions": 10,
48 "started_timestamp_ms": 1712587158800
49 },
50 "user_id": "user_id"
51 }
52]