Publish the working set as a new version

POST /v1/knowledge-bases/{knowledge_base_id}/versions

Freezes the configuration of the draft that If-Match names and a manifest of the latest indexed revision of every Document as the next version (1.53.0; knowledge-bases.md section 9). It refuses with one 422 validation_failed listing every issue (KnowledgePublishIssueCode): a pending Document unless exclude_pending is set, no indexed Document, an embedding space the Organization may not use, or a failed retrieval-quality gate. With activate the version becomes the active one. It emits the Webhook event knowledge_base.version.published. From the second part of the slice the version takes the gate of the Evaluation evaluation_id names, or of the newest current Evaluation of the working set: needed whenever the corpus holds a query (knowledge_evaluation_required), a failed gate refused with one retrieval_gate_failed per failing check, and not_run only with an empty corpus.

Request

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

curl -X POST "$VOCAL_API/v1/knowledge-bases/kb_.../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/knowledge-bases/kb_.../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/knowledge-bases/kb_.../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: KnowledgeBaseVersionPublishRequest.

Responses

Fields of the 201 answer

The shape is KnowledgeBaseVersion.