Skip to main content
PATCH
/
v1
/
knowledge-base
/
{document_id}
Update Knowledge Base Document
curl --request PATCH \
  --url https://api.example.com/v1/knowledge-base/{document_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "metadata": {
    "created_at_unix_secs": 123,
    "last_updated_at_unix_secs": 123,
    "size_bytes": 123
  },
  "extracted_inner_html": "<string>",
  "url": "<string>",
  "dependent_agents": []
}

Headers

x-api-key
string | null

API key for authentication

Path Parameters

document_id
string
required

Body

application/json

Model for updating a knowledge base document (name only)

name
string
required
Required string length: 1 - 500

Response

Successful Response

Knowledge base document detail response (with full content)

id
string
required
name
string
required
type
string
required
metadata
KnowledgeBaseMetadata · object
required

Metadata for knowledge base documents

extracted_inner_html
string
required
url
string | null
dependent_agents
DependentAgent · object[]