Publish the Prompt template draft as a new version

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

Lints the draft that If-Match names and publishes it as the next version (1.55.0). It refuses with one 422 validation_failed listing every issue (PromptPublishIssueCode): each error finding by its lint code and each warning that needs an acknowledgement and is not in acknowledged_warnings. With activate the version becomes the active one. It emits the Webhook event prompt_template.version.published; the Audit event records the acknowledged codes. 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" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/prompt-templates/ptpl_.../versions`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
    '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/prompt-templates/ptpl_.../versions",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: PromptTemplateVersionPublishRequest.

Responses

Fields of the 201 answer

The shape is PromptTemplateVersion.