Update knowledge base document

PATCH

/v1/convai/knowledge-base/:documentation_id

PATCH

/v1/convai/knowledge-base/:documentation_id

curl -X PATCH https://api.elevenlabs.io/v1/convai/knowledge-base/21m00Tcm4TlvDq8ikWAM \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "type": "url",
  "access_info": {
    "is_creator": true,
    "creator_name": "John Doe",
    "creator_email": "john.doe@example.com",
    "role": "admin",
    "anonymous_access_level_override": "admin",
    "access_source": "creator"
  },
  "extracted_inner_html": "extracted_inner_html",
  "id": "id",
  "metadata": {
    "created_at_unix_secs": 1,
    "last_updated_at_unix_secs": 1,
    "size_bytes": 1
  },
  "name": "name",
  "supported_usages": [
    "prompt"
  ],
  "url": "url",
  "auto_sync_info": {
    "minimum_frequency_days": 1,
    "auto_remove": true,
    "consec_failures": 1,
    "next_refresh_by": 1
  },
  "content_format": "html",
  "folder_parent_id": "folder_parent_id",
  "folder_path": [
    {
      "id": "id",
      "name": "name"
    }
  ]
}

Update the name and/or content of a document.

Path parameters

documentation_idstringRequired

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

Request

This endpoint expects an object.

namestringOptional>=1 character

A custom, human-readable name for the document.

contentstringOptional

Updated content for the document. Only supported for text documents, URL documents with auto-sync disabled, and file documents that are not synced from an external source.

Response

Successful Response

urlobject

fileobject

textobject

folderobject

Errors

422

Documents Update Request Unprocessable Entity Error

Path parameters

Headers

Request

Response

Errors