Skip to main content
PUT
Edit knowledge base content

Authorizations

Authorization
string
header
default:<auth-token>
required

Your API token, sent raw (no Bearer prefix).

Path Parameters

knowledgeId
string
required

Body

application/json
markdown
string
required

The full new content. It replaces the current text; it isn't merged with it.

Minimum string length: 1
note
string

A short description of the change, shown on the version.

Maximum string length: 200
Example:

"Updated refund window to 30 days"

Response

The knowledge base, describing the new version while it's indexed.

Status and size fields describe the current version.

knowledgeId
string

5 characters

Example:

"k7x2m"

name
string
Example:

"pricing.pdf"

type
enum<string>
Available options:
pdf,
txt,
csv,
json,
docx,
md,
url
status
enum<string>
  • processing: being parsed and indexed. Not available to agents yet.
  • ready: indexed and available to agents.
  • failed: processing stopped. statusReason says why.
Available options:
processing,
ready,
failed
statusReason
string | null

Why processing failed.

failureCode
string | null

For example upload_failed or job_not_scheduled.

sizeInBytes
integer | null

0 for website knowledge bases.

pageCount
integer | null
sectionCount
integer | null
charCount
integer | null
folderId
string | null

null when it's at the top level.

currentVersion
integer

The version agents read from.

latestVersion
integer

The newest version. It may still be processing

createdAt
string<date-time>
updatedAt
string<date-time>