The maximum number of jobs to include in the response.

List jobs

Start inference job

Get the request details and state of a given job.

Inference

Get job details

Get the JSON predictions of a completed inference job.

Get job predictions

Get the artifacts ZIP of a completed inference job.

Get job artifacts

BatchStartInferenceJobFromLocalFileRequest

Start inference job from local file

Batch

V 0 Stream Models

Stream

Alternative

Bcp47Tag

BoundingBox

x-coordinate of bounding box top left corner.

y-coordinate of bounding box top left corner.

BurstPrediction

A high-dimensional embedding in emotion space.

Modality-specific descriptive features and their scores.

Classification

CompletedEmbeddingGeneration

When this job was created (Unix timestamp in milliseconds).

When this job started (Unix timestamp in milliseconds).

When this job ended (Unix timestamp in milliseconds).

CompletedInference

The number of predictions that were generated by this job.

The number of errors that occurred while running this job.

CompletedState

CompletedTlInference

CompletedTraining

CustomModel

CustomModelId

CustomModelPrediction

CustomModelRequest

CustomModelVersionId

CustomModelsInferenceJob

CustomModelsTrainingJob

Dataset

DatasetId

DatasetVersionId

DescriptionsScore

Name of the descriptive feature being expressed.

Embedding value for the descriptive feature being expressed.

Direction

EmbeddingGenerationBaseRequest

File ID and File URL pairs for an asset registry file

EmbeddingGenerationJob

EmotionScore

Embedding value for the emotion being expressed.

Error

A file path relative to the top level source URL or file.

EvaluationArgs

Face

Face detection probability threshold. Faces detected with a probability less than this threshold will be omitted from the response.

Minimum bounding box side length in pixels to treat as a face. Faces detected with a bounding box side length in pixels less than this threshold will be omitted from the response.

Whether to extract and save the detected faces in the artifacts zip created by each job.

FacePrediction

Time in seconds when face detection occurred.

The predicted probability that a detected face was actually a face.

FacemeshPrediction

FacsScore

Name of the FACS 2.0 feature being expressed.

Embedding value for the FACS 2.0 feature being expressed.

Failed

FailedState

The list of files submitted for analysis.

File

Granularity

GroupedPredictionsBurstPrediction

GroupedPredictionsFacePrediction

GroupedPredictionsFacemeshPrediction

GroupedPredictionsLanguagePrediction

GroupedPredictionsNerPrediction

GroupedPredictionsProsodyPrediction

InProgress

InProgressState

InferenceBaseRequest

Text supplied directly to our Emotional Language and NER models for analysis.

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

InferenceJob

InferencePrediction

InferenceRequest

Text to supply directly to our language and NER models.

InferenceResults

InferenceSourcePredictResult

JobEmbeddingGeneration

JobId

JobInference

JobTlInference

JobTraining

Language

LanguagePrediction

A segment of text (like a word or a sentence).

Models

ModelsPredictions

NerPrediction

Our NER model's relative confidence in the recognized topic or entity.

A measure of how often the entity is linked to by other entities.

A URL which provides more information about the recognized topic or entity.

The specific word to which the emotion predictions are linked.

Null

Position of a segment of text within a larger document, measured in characters. Uses zero-based indexing. The beginning index is inclusive and the end index is exclusive.

PositionInterval

The index of the first character in the text segment, inclusive.

The index of the last character in the text segment, exclusive.

PredictionsOptionalNullBurstPrediction

PredictionsOptionalNullFacePrediction

PredictionsOptionalNullFacemeshPrediction

PredictionsOptionalTranscriptionMetadataLanguagePrediction

PredictionsOptionalTranscriptionMetadataNerPrediction

PredictionsOptionalTranscriptionMetadataProsodyPrediction

Prosody

ProsodyPrediction

Queued

QueuedState

RegistryFileDetail

Regression

SentimentScore

SortBy

Source

SourceFile

SourceTextSource

SourceUrl

StateEmbeddingGeneration

StateEmbeddingGenerationCompletedEmbeddingGeneration

StateEmbeddingGenerationFailed

StateEmbeddingGenerationInProgress

StateEmbeddingGenerationQueued

StateInference

StateTlInference

StateTlInferenceCompletedTlInference

StateTlInferenceFailed

StateTlInferenceInProgress

StateTlInferenceQueued

StateTraining

StateTrainingCompletedTraining

StateTrainingFailed

StateTrainingInProgress

StateTrainingQueued

Status

Target

Task

TaskClassification

TaskRegression

TextSource

A time range with a beginning and end, measured in seconds.

TimeInterval

TlInferenceBaseRequest

TlInferencePrediction

TlInferenceResults

TlInferenceSourcePredictResult

ToxicityScore

TrainingBaseRequest

TrainingCustomModel

Transcription

Transcript confidence threshold. Transcripts generated with a confidence less than this threshold will be considered invalid and not used as an input for model inference.

Transcription metadata for your media file.

TranscriptionMetadata

Type

Unconfigurable

UnionJob

UnionPredictResult

ValidationArgs

When

Window

Configuration used to specify which models should be used and with what settings.

Config

Configuration for the language emotion model.

EmotionEmbedding

EmotionEmbeddingItem

JobDetails

Sentiment

SentimentItem

Level of sentiment, ranging from 1 (negative) to 9 (positive)

StreamBoundingBox

StreamErrorMessage

If a payload ID was passed in the request, the same payload ID will be sent back in the response body.

StreamModelPredictions

Response for the vocal burst emotion model.

Response for the facial expression emotion model.

Response for the speech prosody emotion model.

StreamModelPredictionsBurst

StreamModelPredictionsBurstPredictionsItem

StreamModelPredictionsFace

StreamModelPredictionsFacePredictionsItem

StreamModelPredictionsFacemesh

StreamModelPredictionsFacemeshPredictionsItem

StreamModelPredictionsJobDetails

StreamModelPredictionsLanguage

StreamModelPredictionsLanguagePredictionsItem

StreamModelPredictionsProsody

StreamModelPredictionsProsodyPredictionsItem

StreamModelsEndpointPayload

StreamModelsEndpointPayloadModelsFace

Configuration for FACS predictions. If missing or null, no FACS predictions will be generated.

Configuration for Descriptions predictions. If missing or null, no Descriptions predictions will be generated.

Whether to return identifiers for faces across frames. If true, unique identifiers will be assigned to face bounding boxes to differentiate different faces. If false, all faces will be tagged with an "unknown" ID.

1	[
2	{
3	"job_id": "job_id",
4	"request": {
5	"files": [
6	{
7	"filename": "filename",
8	"md5sum": "md5sum",
9	"content_type": "content_type"
10	}
11	],
12	"models": {
13	"burst": {},
14	"face": {
15	"fps_pred": 3,
16	"identify_faces": false,
17	"min_face_size": 60,
18	"prob_threshold": 0.99,
19	"save_faces": false
20	},
21	"facemesh": {},
22	"language": {
23	"granularity": "word",
24	"identify_speakers": false
25	},
26	"ner": {
27	"identify_speakers": false
28	},
29	"prosody": {
30	"granularity": "utterance",
31	"identify_speakers": false
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": 1712587158717,
42	"ended_timestamp_ms": 1712587159274,
43	"num_errors": 0,
44	"num_predictions": 10,
45	"started_timestamp_ms": 1712587158800,
46	"status": "COMPLETED"
47	},
48	"type": "INFERENCE"
49	}
50	]

1	curl https://api.hume.ai/v0/batch/jobs \
2	-H "X-Hume-Api-Key: <apiKey>"

Query parameters

Response