Activate a Prompt template version

POST /v1/prompt-templates/{prompt_template_id}/versions/{version}/activate

Makes the version the active one and answers it (1.55.0). For an Agent layer it is the version the next Agent publish pins when its prompt names none; for an Organization layer it reaches the next dispatched Call of every Agent that receives the layer, and Calls in progress keep the version they resolved. Activating an older version is the rollback. A write to an Organization layer also needs prompts:admin and is otherwise refused with forbidden and the detail prompts_admin_required.

Request

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

curl -X POST "$VOCAL_API/v1/prompt-templates/ptpl_.../versions/1/activate" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const response = await fetch(`${process.env.VOCAL_API}/v1/prompt-templates/ptpl_.../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/prompt-templates/ptpl_.../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 PromptTemplateVersion.