Skip to main content
POST
Save a model and register a version

Authorizations

Authorization
string
header
required

API key with the vk_ prefix. Create one from the dashboard.

Body

application/json

Body for POST /v1/models/register: save a completed job as a library model and (model versions Task 1) optionally register it into a lineage.

training_job_id
string
required
name
string
required

Library display name (slug).

model
string | null

Lineage name to register the saved model into (created on first use). The saved model becomes the lineage's next version; the response carries it under version.

artifact
string | null

"full" (default) or "adapter" (LoRA jobs; required for fleet flips).

dataset_snapshot_id
string | null

Dataset snapshot (Task 2) or plain dataset id recorded on the version.

tags
string[]

Free-form tags recorded on the version.

Response

The existing model (idempotent repeat save)

object
string
required
id
string
required
name
string
required
base_model
string
required

The base checkpoint this model derives from. For artifact_type 'adapter' this names the model the adapter must be served on top of.

artifact_type
string
required

'full' (standalone checkpoint) | 'adapter' (LoRA adapter; only attachable to a multi_adapter deployment).

source
string
required
status
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
training_job_id
string | null
huggingface_id
string | null
size_bytes
integer<int64> | null
error
string | null
version
null | object

Present when the save also registered the model into a version lineage (POST /v1/models/register with model): the version it became (e.g. acme-bot@v6).