CRBNai API

Update Document

PUT/api/documents/{documentId}

Update a documents attributes.

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Path Params

documentId

string

required

name

string

optional

The new name of the document.

user_metadata

optional

Arbitrary user metadata that will be returned in citations in a Knowledge Bot chat.

{
  "name": "Tutorial: How to do X",
  "user_metadata": {
    "url": "https://google.de"
  }
}

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : Rawtext/plain

{
  "id": "doc_01hdnmm8azwy6dhbsacx8w6c9k",
  "knowledge_bot_id": "kb_01ha1ntvyq68jxezgnkwr63wm1",
  "name": "Tutorial: How to do X",
  "status": "READY",
  "user_metadata": {
    "url": "https://google.de"
  }
}

Last modified: a year ago