List files

Create files

Upload a file synchronously. Returns 201 if successful. Files must have a name. Files must specify Content-Type. Request bodies, and therefore files, are limited to 100MB

FilesUploadFileRequest

Upload file

Get file

Delete file

Update file name

Get file predictions

Files

List datasets

DatasetsCreateDatasetRequest

Create dataset

Get dataset

DatasetsCreateDatasetVersionRequest

Create dataset version

Delete dataset

List dataset versions

List dataset files

Get dataset version

List dataset version files

Datasets

List models

Get model details

Update model name

Hume-generated Model Version IDs to be queried

List model versions

Get model version

Update model description

Models

Start training job

Start custom models inference job

Jobs

Alternative

AttributeFilter

AuthorizedFile

Flag which denotes whether the file is stored with Hume

Timestamp denoting when the file was uploaded to Hume

Indicates whether this file has been sanitized for sharing

Indicates whether this file is owned by the current file reader

Indicates whether this file is linked to a model that is publicly shared

Indicates whether this file is linked to a Hume-owned model that is publicly shared

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.

CompletedTlInference

CompletedTraining

CustomModel

CustomModelId

CustomModelPrediction

CustomModelRequest

CustomModelVersionId

Dataset

DatasetId

DatasetLabels

Boolean indicating that this is the most recent version

DatasetLabelsFileUriInput

DatasetLabelsFileUriInputFeatureTypesValue

DatasetPage

DatasetVersion

Feature types of label mapped to feature type

Hume-generated Dataset ID of the parent Dataset

DatasetVersionFeatureTypesValue

DatasetVersionId

DatasetVersionPage

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

EmotionScore

Embedding value for the emotion being expressed.

Error

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

EvaluationArgs

ExternalModel

ExternalModelVersion

Hume-generated Model ID of the parent Model

Hume-generated Dataset version ID for the Dataset version the Model version was trained on

List of Tags associated with the Model version

Target feature, the feature the model was trained against

ExternalModelVersionFileType

ExternalModelVersionTag

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

File

FileInput

FilePage

FileWithAttributes

FileWithAttributesInput

Granularity

GroupedPredictionsBurstPrediction

GroupedPredictionsFacePrediction

GroupedPredictionsFacemeshPrediction

GroupedPredictionsLanguagePrediction

GroupedPredictionsNerPrediction

GroupedPredictionsProsodyPrediction

InProgress

InferenceBaseRequest

List of File IDs corresponding to the files in the asset registry.

Text to supply directly to our language and NER models.

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

InferencePrediction

InferenceRequest

InferenceResults

InferenceSourcePredictResult

JobEmbeddingGeneration

JobId

JobInference

JobTlInference

JobTraining

JsonObject

Language

LanguagePrediction

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

ModelPage

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

PageableObject

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

RegistryFileDetail

Regression

ReturnDataset

SentimentScore

SortBy

SortObject

Source

SourceFile

SourceTextSource

SourceUrl

StateEmbeddingGeneration

StateEmbeddingGenerationCompletedEmbeddingGeneration

StateEmbeddingGenerationFailed

StateEmbeddingGenerationInProgress

StateEmbeddingGenerationQueued

StateInference

StateInferenceCompletedInference

StateInferenceFailed

StateInferenceInProgress

StateInferenceQueued

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.

1	{
2	"file": {
3	"id": "id",
4	"name": "name",
5	"uri": "uri",
6	"upload_uri": "upload_uri",
7	"thumbnail_uri": "thumbnail_uri",
8	"user_id": "user_id",
9	"data_type": "data_type",
10	"created_on": 1000000,
11	"modified_on": 1000000,
12	"metadata": {
13	"key": {
14	"key": "value"
15	}
16	},
17	"hume_storage": true,
18	"hume_storage_upload_timestamp": 1000000,
19	"is_sanitized": true,
20	"is_owned_by_reader": true,
21	"is_linked_to_publicly_shared": true,
22	"is_linked_to_hume_model": true
23	},
24	"attributes": [
25	{
26	"name": "name",
27	"value": "value"
28	}
29	]
30	}

Get file

Path parameters

Response

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