Upload files
curl --request POST \
--url https://api2.documate.ai/api/v1/queues/{queueId}/files \
--header 'Content-Type: multipart/form-data' \
--header 'X-Api-Key: <api-key>' \
--form 'files=<string>' \
--form 'documentTypeKey=<string>' \
--form documentCount=123 \
--form files.items='@example-file'import fs from 'fs';
const formData = new FormData();
formData.append('files', '<string>');
formData.append('documentTypeKey', '<string>');
formData.append('documentCount', '123');
formData.append('files.items', await new Response(fs.createReadStream('example-file')).blob());
const url = 'https://api2.documate.ai/api/v1/queues/{queueId}/files';
const options = {method: 'POST', headers: {'X-Api-Key': '<api-key>'}, body: formData};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://api2.documate.ai/api/v1/queues/{queueId}/files"
files = { "files.items": ("example-file", open("example-file", "rb")) }
payload = {
"files": "<string>",
"documentTypeKey": "<string>",
"documentCount": "123"
}
headers = {"X-Api-Key": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api2.documate.ai/api/v1/queues/{queueId}/files");
var client = new RestClient(options);
var request = new RestRequest("");
request.AlwaysMultipartFormData = true;
request.AddHeader("X-Api-Key", "<api-key>");
request.AddParameter("files", "<string>");
request.AddParameter("documentTypeKey", "<string>");
request.AddParameter("documentCount", "123");
request.AddFile("files.items", "example-file");
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api2.documate.ai/api/v1/queues/{queueId}/files",
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=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentTypeKey\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentCount\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"queueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fileIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}{
"error": "<string>"
}{
"error": "<string>"
}Uploads
Upload files
Async multipart upload of one or more files. Returns 202 with file IDs. Maximum body size 200 MB.
POST
/
api
/
v1
/
queues
/
{queueId}
/
files
Upload files
curl --request POST \
--url https://api2.documate.ai/api/v1/queues/{queueId}/files \
--header 'Content-Type: multipart/form-data' \
--header 'X-Api-Key: <api-key>' \
--form 'files=<string>' \
--form 'documentTypeKey=<string>' \
--form documentCount=123 \
--form files.items='@example-file'import fs from 'fs';
const formData = new FormData();
formData.append('files', '<string>');
formData.append('documentTypeKey', '<string>');
formData.append('documentCount', '123');
formData.append('files.items', await new Response(fs.createReadStream('example-file')).blob());
const url = 'https://api2.documate.ai/api/v1/queues/{queueId}/files';
const options = {method: 'POST', headers: {'X-Api-Key': '<api-key>'}, body: formData};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://api2.documate.ai/api/v1/queues/{queueId}/files"
files = { "files.items": ("example-file", open("example-file", "rb")) }
payload = {
"files": "<string>",
"documentTypeKey": "<string>",
"documentCount": "123"
}
headers = {"X-Api-Key": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api2.documate.ai/api/v1/queues/{queueId}/files");
var client = new RestClient(options);
var request = new RestRequest("");
request.AlwaysMultipartFormData = true;
request.AddHeader("X-Api-Key", "<api-key>");
request.AddParameter("files", "<string>");
request.AddParameter("documentTypeKey", "<string>");
request.AddParameter("documentCount", "123");
request.AddFile("files.items", "example-file");
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api2.documate.ai/api/v1/queues/{queueId}/files",
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=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentTypeKey\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentCount\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"queueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fileIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
API key from the Documate app (Settings → API keys). You may also send Authorization: ApiKey YOUR_API_KEY.
Path Parameters
Channel ID from the Documate app.
Body
multipart/form-data