List jobs | Hume API

curl https://api.hume.ai/ \
     -H "X-Hume-Api-Key: <apiKey>"

[
  {
    "job_id": "job_id",
    "request": {
      "files": [
        {
          "filename": "filename",
          "md5sum": "md5sum",
          "content_type": "content_type"
        }
      ],
      "models": {
        "burst": {},
        "face": {
          "fps_pred": 3,
          "identify_faces": false,
          "min_face_size": 60,
          "prob_threshold": 0.99,
          "save_faces": false
        },
        "facemesh": {},
        "language": {
          "granularity": "word",
          "identify_speakers": false
        },
        "ner": {
          "identify_speakers": false
        },
        "prosody": {
          "granularity": "utterance",
          "identify_speakers": false
        }
      },
      "notify": true,
      "text": [],
      "urls": [
        "https://hume-tutorials.s3.amazonaws.com/faces.zip"
      ]
    },
    "state": {
      "created_timestamp_ms": 1712587158717,
      "ended_timestamp_ms": 1712587159274,
      "num_errors": 0,
      "num_predictions": 10,
      "started_timestamp_ms": 1712587158800,
      "status": "COMPLETED"
    },
    "type": "INFERENCE"
  }
]

Sort and filter jobs.

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.

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.

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).

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

object