Activate a published Agent version

POST /v1/agents/{agent_id}/versions/{version}/activate

Makes a published version the one new Calls run and answers it (1.63.0; api.md section 4): a rollback is the activation of an older version. A running experiment stops with the reason active_version_changed, as a publish that activates stops it. A retired version is 409 agent_version_unavailable; activating the active version answers it unchanged. An Agent whose owner turned the publish gate on activates only a version whose latest completed run of the gating suite, a suite run or a conversation test run at the suite's current revision, passed the gate, and refuses otherwise with 422 evaluation_gate_failed, one detail per EvaluationGateReason with the agent_version and, for a failed check, the run_id; a rollback is gated too, and in an incident the owner turns the gate off first.

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_.../versions/1/activate" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const response = await fetch(`${process.env.VOCAL_API}/v1/agents/agt_.../versions/1/activate`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
console.log(response.status, await response.text());

import os
import uuid

import requests

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

Parameters

Responses

Fields of the 200 answer

The shape is AgentVersion.