Skip to the content

Update the Knowledge base draft

PATCH /v1/knowledge-bases/{knowledge_base_id}

Property	Value
Operation	`update_knowledge_base`
Group	Knowledge bases
Scope	`knowledge:write`
Route class	`control`
Idempotency	No `Idempotency-Key`
Audit	Audited `knowledge.knowledge_base.update` (mutation)
Released in	1.53.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Replaces the named fields of the draft at the revision If-Match names (1.53.0), checked as a creation is. A change of embedding or chunking starts an Ingestion run with cause reindex on every Source; versions already published keep their configuration. An archived Knowledge base is refused with knowledge_base_archived.

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 PATCH "$VOCAL_API/v1/knowledge-bases/kb_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/knowledge-bases/kb_...`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os

import requests

response = requests.patch(
    f"{os.environ['VOCAL_API']}/v1/knowledge-bases/kb_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`knowledge_base_id`	path	KnowledgeBaseId	yes	The id of a Knowledge base: `kb_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`if-match`	header	string	yes	The revision the change was made against, quoted as the ETag returns it, or `*` to overwrite.

Request body

Content type application/json, required: KnowledgeBaseUpdateRequest.

Field	Type	Required	Description
`auto_publish`	KnowledgeAutoPublish	no
`chunking`	KnowledgeChunkingInput	no
`description`	string or null	no
`embedding`	KnowledgeEmbeddingInput	no
`language`	LanguageTag	no
`name`	KnowledgeBaseName	no
`phi_content`	KnowledgePhiContent	no
`retrieval_defaults`	KnowledgeRetrievalDefaultsInput	no
`sensitive_content`	KnowledgeSensitiveContentInput	no

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	KnowledgeBase
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`, `org_suspended`
`404`	`application/json`	ErrorEnvelope	`not_found`
`409`	`application/json`	ErrorEnvelope	`knowledge_base_archived`
`412`	`application/json`	ErrorEnvelope	`revision_mismatch`
`422`	`application/json`	ErrorEnvelope	`validation_failed`, `capability_not_available`
`428`	`application/json`	ErrorEnvelope	`precondition_required`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is KnowledgeBase.

Field	Type	Required	Description
`active_version`	integer or null	yes	The version bindings that track `active` resolve at dispatch, or null when none is active.
`archived_at`	Timestamp or null	yes	When `DELETE` archived the Knowledge base, or null. An archived Knowledge base takes no write, upload, sync or publish (409 `knowledge_base_archived`).
`auto_publish`	KnowledgeAutoPublish	yes
`chunking`	KnowledgeChunking	yes
`created_at`	Timestamp	yes
`description`	string or null	yes
`document_count`	integer	no	The Documents of the Knowledge base that are not `removed`, whatever their status (1.54.0); absent from an api before 1.54.0.
`embedding`	KnowledgeEmbedding	yes
`id`	KnowledgeBaseId	yes
`language`	LanguageTag	yes
`latest_version`	integer or null	yes	The highest published version, or null before the first publish.
`name`	KnowledgeBaseName	yes
`object`	`"knowledge_base"`	yes
`organization_id`	OrganizationId	yes
`phi_content`	KnowledgePhiContent	yes
`retrieval_defaults`	KnowledgeRetrievalDefaults	yes
`revision`	integer	yes	Counts writes to the draft; returned as the ETag and required in If-Match.
`sensitive_content`	KnowledgeSensitiveContent	yes
`source_count`	integer	no	The Sources of the Knowledge base that are not deleted (1.54.0); absent from an api before 1.54.0.
`updated_at`	Timestamp	yes