post https://api.voiceflow.com/v3alpha/knowledge-base/docs/upload
Uploads a document of type "url" to the Knowledge Base. Limit is one url per call.
All requests to any Knowledge Base APIs require a Dialog Manager API Key.
To obtain this key, go to the Integration tab on the project you uploaded data sources to and click the "Copy API key" button.
Request Fields
| Property | Description & Example |
|---|---|
| Authorization (header) | Dialog Manager API Key |
| Content-Type (header) | application/json; charset=utf-8 |
| overwrite (query parameter) | Optional - Specify whether to overwrite existing data (optional). "True" means you want to overwrite. |
| 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 answers type: 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. |
Example
Sample Route with query parameters:
https://api.voiceflow.com/v3alpha/knowledge-base/docs/upload?tags=["beginner","small_scale"]
Sample Request
{
"data": {
"type": "url",
"url": "https://www.familyhandyman.com/article/simple-step-stool/",
"name": "https://www.familyhandyman.com/article/simple-step-stool/"
}
}
Sample Response
{
"data": {
"documentID": "6515dccab4bc5400060fbc6a",
"data": {
"type": "url",
"name": "familyhandyman.com/article/simple-step-stool/",
"url": "https://www.familyhandyman.com/article/simple-step-stool/"
},
"updatedAt": "2023-09-28T20:06:34.049Z",
"status": {
"type": "PENDING"
},
"tags": [
"beginner",
"small_scale"
]
}
}