Agents Platform

Update Document

Update the name and/or content of a document.

patch/v1/convai/knowledge-base/{documentation_id}

Path parameters

documentation_idstring required

The id of a document from the knowledge base. This is returned on document addition.

Example:21m00Tcm4TlvDq8ikWAM

The id of a document from the knowledge base. This is returned on document addition.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

namestring nullable

A custom, human-readable name for the document.

contentstring nullable

Updated content for the document. Only supported for text documents, URL documents with auto-sync disabled, and file documents.

Response

Successful Response

Example response

{
  "access_info": {
    "access_source": "creator",
    "creator_email": "john.doe@example.com",
    "creator_name": "John Doe",
    "is_creator": true,
    "role": "admin"
  }
}

Changes

Changed in 2 of the 49 revisions of this API.6

Sep 26, 20264a6716242c9e3See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
Jul 26, 2026494d96419d153See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history