Skip to main content
POST
Evaluate a version for the promotion gate

Authorizations

Authorization
string
header
required

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

Path Parameters

name
string
required

Lineage name

version
string
required

Version: "v3" or "3"

Response

Accepted (status queued); poll GET /v1/experiments/{id}

One experiment.

object
string
required

Always "experiment".

id
string
required

exp_...

name
string
required
status
string
required

queued | running | awaiting_local | completed | failed | canceled

dataset_id
string
required
dataset_snapshot_id
string
required

The snapshot the run is pinned to (<dataset_id>@snap-N).

target
object
required

The target as requested.

evaluators
object[]
required

The pinned evaluator versions (+ each judge's served model).

bindings
object
required
generation
object
required

Sampling params for the target's calls. Omitted = the server default.

trials
integer<int32>
required
items_total
integer<int32>
required

Items = rows x trials; done counts finished items (ok or error).

items_done
integer<int32>
required
created_at
string<date-time>
required
target_deployment_id
string | null

Resolved at create: the deployment called, the request model sent (an adapter's versioned internal name for a model version on a fleet), the model version, and the served model's identity.

target_model
string | null
target_model_version_id
string | null
target_served_model
string | null
aggregates
object | null

Per evaluator at completion: n, ok, errors, skipped, pass_rate (all items in the denominator), mean, label_counts, critical_failures.

passed
boolean | null

Every evaluator with a pass rule passed every item with no errors; null until completed, or when no evaluator has a pass rule.

baseline_experiment_id
string | null
diff
object | null

The diff against the baseline, computed at completion.

error
string | null
created_by
string | null
started_at
string<date-time> | null
finished_at
string<date-time> | null