Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hume AI subpackage_batch API

The subpackage_batch API from Hume AI — 4 operation(s) for subpackage_batch.

Hume AI subpackage_batch API is one of 9 APIs that Hume AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include subpackage_batch. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and an AsyncAPI specification.

This API exposes 5 operations across 4 paths, and defines 65 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.hume.ai.

5 operations 4 paths 65 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.hume.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Hume AI subpackage_batch API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Hume-Api-Key (bearerAuth).

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_batch 5
GET
/v0/batch/jobs
List jobs
list-jobs 7 params → 200
POST
/v0/batch/jobs
Start inference job from local file
start-inference-job-from-local-file body → 200
GET
/v0/batch/jobs/{id}
Get job details
get-job-details 2 params → 200
GET
/v0/batch/jobs/{id}/predictions
Get job predictions
get-job-predictions 2 params → 200
GET
/v0/batch/jobs/{id}/artifacts
Get job artifacts
get-job-artifacts 2 params → 200

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are batch:NerPrediction (10 properties), batch:LanguagePrediction (8 properties), batch:FacePrediction (7 properties), batch:InferenceRequest (7 properties). Each schema is shown below with its type and property counts.

batch:ProsodyWindow
object
2 properties
batch:InferenceSourcePredictResult
object
3 properties 1 required
batch:NerPrediction
object
10 properties 7 required
batch:ProsodyGranularity
object
batch:ModelsProsody
object
3 properties
batch:LanguageSentiment
object
batch:ToxicityScore
object
2 properties 2 required
batch:GroupedPredictions
object
2 properties 2 required
batch:JobId
object
1 property 1 required
batch:V0BatchJobsPostRequestBodyContentMultipartFormDataSchemaJson
object
Stringified JSON object containing the inference job configuration.
6 properties
batch:V0BatchJobsGetParametersSortBy
object
batch:TimeInterval
object
A time range with a beginning and end, measured in seconds.
2 properties 2 required
batch:SentimentScore
object
2 properties 2 required
batch:ModelsBurst
object
batch:Status
string
batch:Source
batch:ModelsPredictionsBurst
object
2 properties 1 required
batch:ModelsPredictionsFacemesh
object
2 properties 1 required
batch:ModelsLanguage
object
4 properties
batch:ModelsFacemesh
object
batch:ModelsFace
object
7 properties
batch:Null
object
No associated metadata for this model. Value will be null.
batch:InferenceRequestTranscription
object
3 properties
batch:InferenceBaseRequestModels
object
Specify the models to use for inference. If this field is not explicitly set, then all models will run by default.
6 properties
batch:BurstPrediction
object
3 properties 3 required
batch:V0BatchJobsGetParametersWhen
object
batch:UnionJob
batch:File
object
The list of files submitted for analysis.
3 properties 1 required
batch:ModelsPredictionsFace
object
2 properties 1 required
batch:GroupedPredictions
object
2 properties 2 required
batch:TranscriptionMetadata
object
Transcription metadata for your media file.
2 properties 1 required
batch:GroupedPredictions
object
2 properties 2 required
batch:GroupedPredictions
object
2 properties 2 required
batch:TranscriptionMetadataDetectedLanguage
object
batch:BoundingBox
object
A bounding box around a face.
4 properties 4 required
batch:FacemeshPrediction
object
1 property 1 required
batch:ModelsPredictionsProsody
object
2 properties 1 required
batch:FacePrediction
object
7 properties 5 required
batch:PositionInterval
object
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…
2 properties 2 required
batch:GroupedPredictions
object
2 properties 2 required
batch:UnionPredictResult
batch:V0BatchJobsGetParametersDirection
object
batch:FacsScore
object
2 properties 2 required
batch:ProsodyPrediction
object
5 properties 2 required
batch:InferenceBaseRequestTranscription
object
3 properties
batch:LanguagePrediction
object
8 properties 3 required
batch:ModelsPredictions
object
6 properties
batch:TranscriptionLanguage
object
By default, we use an automated language detection method for our Speech Prosody, Language, and NER models. However, if you know what language is being spoken…
batch:DescriptionsScore
object
2 properties 2 required
batch:InferenceRequestModels
object
6 properties
batch:GroupedPredictions
object
2 properties 2 required
batch:State
batch:InferenceRequest
object
7 properties 1 required
batch:FaceFacs
object
batch:UnionJob_Job
object
4 properties 4 required
batch:InferencePrediction
object
2 properties 2 required
batch:ModelsNer
object
1 property
batch:ModelsPredictionsLanguage
object
2 properties 1 required
batch:ModelsPredictionsNer
object
2 properties 1 required
batch:InferenceResults
object
2 properties 2 required
batch:LanguageToxicity
object
batch:EmotionScore
object
2 properties 2 required
batch:FaceDescriptions
object
batch:LanguageGranularity
object
batch:Error
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hume-ai-subpackage-batch-api-openapi.yml Raw ↑

Other APIs Hume AI publishes across the network.

Hume AI Ai Default API
Hume AI subpackage_chatGroups API
Hume AI subpackage_chats API
Hume AI subpackage_configs API
Hume AI subpackage_controlPlane API
Hume AI subpackage_prompts API
Hume AI subpackage_tools API
Hume AI subpackage_voices API