CRBNai API

Update Document

PUT

/api/documents/{documentId}

document

Update a documents attributes.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

documentId

string

required

Body Params application/json

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.

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://app.crbnai.com/api/documents/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Tutorial: How to do X",
    "user_metadata": {
        "url": "https://google.de"
    }
}'

Responses

🟢200OK

text/plain

Body

object {0}

Example

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

Modified at 2023-12-14 17:19:14

Download Document

Add Document to Knowledge Bot