Promote a candidate of an experiment

POST /v1/agents/{agent_id}/experiments/{experiment_id}/promote

Activates the candidate of a running or stopped experiment, as a publish with activate would, ends the experiment promoted and emits experiment.stopped (1.55.0). A Member decides: Vocal never declares a winner. With two candidates the body names the arm (experiment_arm_required). A draft is 409 experiment_conflict with the reason not_started, a promoted experiment with promoted; a candidate retired since is 409 agent_version_unavailable. From 1.63.0 an Agent whose owner turned the publish gate on promotes only a candidate whose latest run of the gating suite passed it, at the suite's current revision, and refuses otherwise with 422 evaluation_gate_failed, one detail per EvaluationGateReason.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the agents:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/agents/agt_.../experiments/exp_.../promote" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/agents/agt_.../experiments/exp_.../promote`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/agents/agt_.../experiments/exp_.../promote",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: ExperimentPromoteRequest.

Responses

Fields of the 200 answer

The shape is Experiment.