Models

Update model description

PATCH
Returns 200 if successful

Path parameters

idstringRequired
Hume-generated ID of a Model Version

Request

This endpoint expects a string.

Response

This endpoint returns an object
id
string
Hume-generated Model version ID
model_id
string
Hume-generated Model ID of the parent Model
user_id
string
Hume-generated User ID
version
string
Model version number
source_uri
string
Model version's source file URI
dataset_version_id
string
Hume-generated Dataset version ID for the Dataset version the Model version was trained on
created_on
integer
Created date and time
metadata
map from strings to maps from strings to anyOptional
Additional details as key, value pairs
description
stringOptional
Model version description
tags
list of objectsOptional
List of Tags associated with the Model version
file_type
enumOptional

File type: video, audio, video_no_audio, image, text, or mediapipe_facemesh

target_feature
stringOptional
Target feature, the feature the model was trained against
task_type
stringOptional
Type of the task used to train
training_job_id
stringOptional
ID of the batch training job
PATCH
1curl -X PATCH https://api.hume.ai/v0/registry/models/version/id \
2 -H "X-Hume-Api-Key: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d "string"
200Updated
1{
2 "id": "id",
3 "model_id": "model_id",
4 "user_id": "user_id",
5 "version": "version",
6 "source_uri": "source_uri",
7 "dataset_version_id": "dataset_version_id",
8 "created_on": 1,
9 "metadata": {
10 "metadata": {
11 "metadata": {
12 "key": "value"
13 }
14 }
15 },
16 "description": "description",
17 "tags": [
18 {
19 "key": "key",
20 "value": "value"
21 }
22 ],
23 "file_type": "video",
24 "target_feature": "target_feature",
25 "task_type": "task_type",
26 "training_job_id": "training_job_id"
27}