Initiate File Uploads
curl --request POST \
--url https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"files": [
{
"fileName": "document.pdf",
"mimeType": "application/pdf",
"fileSize": 1024000
},
{
"fileName": "document_2.pdf",
"mimeType": "application/pdf",
"fileSize": 512000
}
]
}
'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate"
payload = { "files": [
{
"fileName": "document.pdf",
"mimeType": "application/pdf",
"fileSize": 1024000
},
{
"fileName": "document_2.pdf",
"mimeType": "application/pdf",
"fileSize": 512000
}
] }
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
files: [
{fileName: 'document.pdf', mimeType: 'application/pdf', fileSize: 1024000},
{fileName: 'document_2.pdf', mimeType: 'application/pdf', fileSize: 512000}
]
})
};
fetch('https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate', 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://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'files' => [
[
'fileName' => 'document.pdf',
'mimeType' => 'application/pdf',
'fileSize' => 1024000
],
[
'fileName' => 'document_2.pdf',
'mimeType' => 'application/pdf',
'fileSize' => 512000
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <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://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate"
payload := strings.NewReader("{\n \"files\": [\n {\n \"fileName\": \"document.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 1024000\n },\n {\n \"fileName\": \"document_2.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 512000\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"files\": [\n {\n \"fileName\": \"document.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 1024000\n },\n {\n \"fileName\": \"document_2.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 512000\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"files\": [\n {\n \"fileName\": \"document.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 1024000\n },\n {\n \"fileName\": \"document_2.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 512000\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uploads": [
{
"uploadId": "550e8400-e29b-41d4-a716-446655440000",
"fileName": "document.pdf",
"mimeType": "application/pdf",
"fileSize": 1024000,
"s3Key": "my-app-id/uploads/550e8400/document.pdf",
"presignedUrl": "https://s3.amazonaws.com/bucket/..."
}
]
}Knowledge Base
Initiate File Uploads
Generates presigned URLs and creates upload records for one or more files. Use this endpoint to prepare files for upload to the knowledge base.
Workflow: After receiving the presigned URLs, upload the files directly to the provided URLs, then use the Add Knowledge Base Files endpoint to associate them with an agent.
POST
/
ai-agents
/
agent-builder
/
knowledge-base
/
uploads
/
initiate
Initiate File Uploads
curl --request POST \
--url https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"files": [
{
"fileName": "document.pdf",
"mimeType": "application/pdf",
"fileSize": 1024000
},
{
"fileName": "document_2.pdf",
"mimeType": "application/pdf",
"fileSize": 512000
}
]
}
'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate"
payload = { "files": [
{
"fileName": "document.pdf",
"mimeType": "application/pdf",
"fileSize": 1024000
},
{
"fileName": "document_2.pdf",
"mimeType": "application/pdf",
"fileSize": 512000
}
] }
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
files: [
{fileName: 'document.pdf', mimeType: 'application/pdf', fileSize: 1024000},
{fileName: 'document_2.pdf', mimeType: 'application/pdf', fileSize: 512000}
]
})
};
fetch('https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate', 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://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'files' => [
[
'fileName' => 'document.pdf',
'mimeType' => 'application/pdf',
'fileSize' => 1024000
],
[
'fileName' => 'document_2.pdf',
'mimeType' => 'application/pdf',
'fileSize' => 512000
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <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://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate"
payload := strings.NewReader("{\n \"files\": [\n {\n \"fileName\": \"document.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 1024000\n },\n {\n \"fileName\": \"document_2.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 512000\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"files\": [\n {\n \"fileName\": \"document.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 1024000\n },\n {\n \"fileName\": \"document_2.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 512000\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/uploads/initiate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"files\": [\n {\n \"fileName\": \"document.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 1024000\n },\n {\n \"fileName\": \"document_2.pdf\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 512000\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uploads": [
{
"uploadId": "550e8400-e29b-41d4-a716-446655440000",
"fileName": "document.pdf",
"mimeType": "application/pdf",
"fileSize": 1024000,
"s3Key": "my-app-id/uploads/550e8400/document.pdf",
"presignedUrl": "https://s3.amazonaws.com/bucket/..."
}
]
}Authorizations
API Key (i.e. Rest API Key from the Dashboard).
Body
application/json
List of files to upload
Show child attributes
Show child attributes
Response
200 - application/json
Presigned URLs generated and upload records created successfully
Show child attributes
Show child attributes
Was this page helpful?