Skip to main content
POST
Upgrade a face collection to the current storage format

Authorizations

X-License-Key
string
header
required

Raw Jumper Pro license key on every authenticated request, without a Bearer prefix

Body

application/json
cache_dir
string
required
cluster_job_name
string
required
progress_room_id
string

A Socket.IO room the client has already joined. Progress is sent there and the room is returned as task_id, so an upgrade that fails within moments is still heard. Without it, or when it doesn't match the pattern, Jumper makes a room.

Pattern: ^[A-Za-z0-9_-]{8,64}$
allow_missing_names
boolean
default:false

Upgrade a collection whose file with the names of its people is damaged without those names. Without it such an upgrade ends with an error event that has names_unreadable set to true. Names that can be read are always kept.

Response

The collection is already in the current format

message
string
face_storage_version
string