Knowledge

Update knowledge document

Beta
PUT
Update knowledge document. Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the latest version is not in progress.

Request

This endpoint expects an object.
content
stringRequired
The content of the document. Not shown directly to users. May be provided in HTML or markdown. HTML will be converted to markdown automatically. Images are not currently supported and will be ignored.
content_type
enumRequired
The type of the knowledge document content. Markdown preferred.
Allowed values: HTMLMARKDOWN
document_id
stringRequired
Externally supplied ID that uniquely identifies this document. It is used to deduplicate documents and facilitate operations such as updating or deleting documents when calculating changes in the knowledge base.
knowledge_base_id
stringRequired
External ID of the knowledge base used to create this document. Must have an active version.
title
stringRequired
The title of the document. Will be shown as part of answers.
author
stringOptional
The name of the author who created this document.
created_at
datetimeOptional
The time at which this document was created.
language
stringOptional
The document language. Must be a valid ISO 639-1 language code.
updated_at
datetimeOptional
The time at which this document was last modified.
url
stringOptional
The URL of the document. Should be visible to end users. Will be shown as part of answers.

Response

This endpoint returns an object
content
string
The content of the document in markdown format. Not shown directly to users.
document_id
string
Externally supplied ID that uniquely identifies this document. It is used to deduplicate documents and facilitate operations such as updating or deleting documents when calculating changes in the knowledge base.
knowledge_base_id
string
External ID of the knowledge base used to create this document. Must have an active version.
title
string
The title of the document. Will be shown as part of answers.
author
stringOptional
The name of the author who created this document.
created_at
datetimeOptional
The time at which this document was created.
language
stringOptional
The document language. Must be a valid ISO 639-1 language code.
updated_at
datetimeOptional
The time at which this document was last modified.
url
stringOptional
The URL of the document. Should be visible to end users. Will be shown as part of answers.

Errors