Upload File
curl --request POST \
--url https://gateway.widebot.net/api/UploadBlob \
--header 'Content-Type: multipart/form-data' \
--header 'x-bot: <api-key>' \
--header 'x-user-auth: <api-key>' \
--form Attachment='@example-file' \
--form Model.FileType=File \
--form 'ConvertAttachmentTo=<string>' \
--form EncryptFileName=falseimport requests
url = "https://gateway.widebot.net/api/UploadBlob"
files = { "Attachment": ("example-file", open("example-file", "rb")) }
payload = {
"Model.FileType": "File",
"ConvertAttachmentTo": "<string>",
"EncryptFileName": "false"
}
headers = {
"x-user-auth": "<api-key>",
"x-bot": "<api-key>"
}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('Attachment', '<string>');
form.append('Model.FileType', 'File');
form.append('ConvertAttachmentTo', '<string>');
form.append('EncryptFileName', 'false');
const options = {method: 'POST', headers: {'x-user-auth': '<api-key>', 'x-bot': '<api-key>'}};
options.body = form;
fetch('https://gateway.widebot.net/api/UploadBlob', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://gateway.widebot.net/api/UploadBlob",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Attachment\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model.FileType\"\r\n\r\nFile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ConvertAttachmentTo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"EncryptFileName\"\r\n\r\nfalse\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-bot: <api-key>",
"x-user-auth: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://gateway.widebot.net/api/UploadBlob"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Attachment\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model.FileType\"\r\n\r\nFile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ConvertAttachmentTo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"EncryptFileName\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-user-auth", "<api-key>")
req.Header.Add("x-bot", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://gateway.widebot.net/api/UploadBlob")
.header("x-user-auth", "<api-key>")
.header("x-bot", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Attachment\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model.FileType\"\r\n\r\nFile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ConvertAttachmentTo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"EncryptFileName\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.widebot.net/api/UploadBlob")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-user-auth"] = '<api-key>'
request["x-bot"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Attachment\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model.FileType\"\r\n\r\nFile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ConvertAttachmentTo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"EncryptFileName\"\r\n\r\nfalse\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"FileURL": "<string>",
"FileMimeType": "text/plain",
"FileName": "<string>",
"FilePath": "<string>"
}Upload File
Upload a raw file (blob) to be used as a knowledge unit source. Returns the stored file details, which you then pass to “Register Knowledge Unit” (KnowledgeSource = 0) to index it.
This replaces the older presigned-URL upload flow.
Process:
- Upload the file here as multipart/form-data
- Call “Register Knowledge Unit” with the returned file details
Supported File Types:
- PDF documents
- Microsoft Word (DOCX)
- Plain text (TXT)
- Rich text (RTF)
- And other common document formats
Note: Example requests/responses shown here are illustrative. When using the live “Try it” tool, you may see two responses: an HTTP status preview and the API’s JSON body.
POST
/
api
/
UploadBlob
Upload File
curl --request POST \
--url https://gateway.widebot.net/api/UploadBlob \
--header 'Content-Type: multipart/form-data' \
--header 'x-bot: <api-key>' \
--header 'x-user-auth: <api-key>' \
--form Attachment='@example-file' \
--form Model.FileType=File \
--form 'ConvertAttachmentTo=<string>' \
--form EncryptFileName=falseimport requests
url = "https://gateway.widebot.net/api/UploadBlob"
files = { "Attachment": ("example-file", open("example-file", "rb")) }
payload = {
"Model.FileType": "File",
"ConvertAttachmentTo": "<string>",
"EncryptFileName": "false"
}
headers = {
"x-user-auth": "<api-key>",
"x-bot": "<api-key>"
}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('Attachment', '<string>');
form.append('Model.FileType', 'File');
form.append('ConvertAttachmentTo', '<string>');
form.append('EncryptFileName', 'false');
const options = {method: 'POST', headers: {'x-user-auth': '<api-key>', 'x-bot': '<api-key>'}};
options.body = form;
fetch('https://gateway.widebot.net/api/UploadBlob', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://gateway.widebot.net/api/UploadBlob",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Attachment\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model.FileType\"\r\n\r\nFile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ConvertAttachmentTo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"EncryptFileName\"\r\n\r\nfalse\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-bot: <api-key>",
"x-user-auth: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://gateway.widebot.net/api/UploadBlob"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Attachment\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model.FileType\"\r\n\r\nFile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ConvertAttachmentTo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"EncryptFileName\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-user-auth", "<api-key>")
req.Header.Add("x-bot", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://gateway.widebot.net/api/UploadBlob")
.header("x-user-auth", "<api-key>")
.header("x-bot", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Attachment\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model.FileType\"\r\n\r\nFile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ConvertAttachmentTo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"EncryptFileName\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.widebot.net/api/UploadBlob")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-user-auth"] = '<api-key>'
request["x-bot"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Attachment\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Model.FileType\"\r\n\r\nFile\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ConvertAttachmentTo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"EncryptFileName\"\r\n\r\nfalse\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"FileURL": "<string>",
"FileMimeType": "text/plain",
"FileName": "<string>",
"FilePath": "<string>"
}Authorizations
Your API key from account settings
Your bot ID from account settings
Body
multipart/form-data
The file to upload
Optional: Image, Audio, Video, or File. Inferred from the file content-type if omitted.
Example:
"File"
Optional target format to convert the attachment to
Whether to encrypt the stored file name
Was this page helpful?
⌘I

