Replaces the document and document name in the Knowledge Base, by documentID (of type "url" only). Limit one per call.

Request Fields

PropertyDescription & Example
Content-Type
(header)
application/json; charset=utf-8
documentID
(path variable)
A unique identifier of the document object (a string).
To get the list of documentID's, use the GET Document List Knowledge Base API.
maxChunkSize
(query parameter)
Optional - Determine how granularly each document is broken up.
Max chunk size affects the total amount of chunks parsed from a document.
(i.e. larger chunks means less chunks retrieved)

Smaller chunk size means:

- narrower context
- faster response
- less tokens consumed
- greater risk of less accurate answerstype: integer ; default: 1000; Range available is 500-1500 tokens.
Once uploaded, you can view the chunks using the GET Document Chunk Retrieval Knowledge Base API.
JSON script
(body, raw)
Format Example:
{
"data": {
"type": "url",
"url": "https://voiceflow.com/"
}
}

Sample Response

{
    "status": {
        "type": "PENDING"
    },
    "data": {
        "type": "url",
        "name": "voiceflow.com/",
        "url": "https://voiceflow.com/"
    },
    "updatedAt": "2023-08-09T21:20:29.706Z",
    "documentID": "64ca6b5e89cc410007bad5cd"
}
Language
Authorization
Header
Click Try It! to start a request and see the response here!