Update Knowledge Base Document

Update a knowledge base document (name, parent folder, etc.)

PATCH /v1/voiceai/knowledge-base/{document_id}

Update Knowledge Base Document

cURL

curl --request PATCH \
  --url https://api.threetone.in/v1/voiceai/knowledge-base/{document_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "metadata": {
    "created_at_unix_secs": 123,
    "last_updated_at_unix_secs": 123,
    "size_bytes": 123
  },
  "access_info": {
    "is_creator": true,
    "creator_name": "<string>",
    "creator_email": "<string>",
    "role": "admin"
  },
  "url": "<string>",
  "extracted_inner_html": "<string>",
  "supported_usages": [
    "prompt"
  ],
  "folder_parent_id": "<string>",
  "folder_path": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "type": "url"
}

Authorizations

APIKeyHeaderHTTPBearer

x-api-key · string · header · required

API key for programmatic access

Path Parameters

document_id · string · required

Body

application/json

Request body for PATCH /knowledge-base/{documentation_id} endpoint. Update the name of a document.

name · string · required

A custom, human-readable name for the document.

Minimum string length: 1

Response

200

application/json

Successful Response

GetKnowledgeBaseURLResponseModel

GetKnowledgeBaseFileResponseModel

GetKnowledgeBaseTextResponseModel

GetKnowledgeBaseFolderResponseModel

Knowledge base document response for URL type

id · string · required

Document ID

name · string · required

Document name

metadata · KnowledgeBaseDocumentMetadataResponseModel · object · required

Document metadata

Show child attributes

access_info · ResourceAccessInfo · object · required

Access information for the requesting user

Show child attributes

url · string · required

The source URL

extracted_inner_html · string · required

The extracted content from the URL

supported_usages · enum<string>[]

Supported usage modes for this document

How the document is used in agent context.

• prompt: Always include full document in LLM context
• auto: Use RAG to retrieve relevant chunks

Available options: prompt, auto

folder_parent_id · string | null

The ID of the parent folder, or null if the document is at the root level.

folder_path · KnowledgeBaseFolderPathSegmentResponseModel · object[]

The folder path segments leading to this entity, from root to parent folder.

Show child attributes

type · string · default: url

Document type discriminator

Allowed value: "url"