Jobs

Start custom models inference job

POST
Start a new custom models inference job.

Request

This endpoint expects an object.
custom_model
unionRequired
urls
list of stringsOptional

URLs to the media files to be processed. Each must be a valid public URL to a media file (see recommended input filetypes) or an archive (.zip, .tar.gz, .tar.bz2, .tar.xz) of media files.

If you wish to supply more than 100 URLs, consider providing them as an archive (.zip, .tar.gz, .tar.bz2, .tar.xz).

registry_files
list of stringsOptional
List of File IDs corresponding to the files in the asset registry.
callback_url
stringOptional

If provided, a POST request will be made to the URL with the generated predictions on completion or the error message on failure.

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

Response

This endpoint returns an object
job_id
string
The ID of the started job.
POST
1curl -X POST https://api.hume.ai/v0/registry/v0/batch/jobs/tl/inference \
2 -H "X-Hume-Api-Key: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "custom_model": {
6 "id": "id"
7 }
8}'
200Successful
1{
2 "job_id": "job_id"
3}