Complete a multipart intake upload
curl --request POST \
--url https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"documentVersion": "<string>",
"externalData": {},
"extraFields": {},
"filename": "<string>",
"knowledgeFeatures": [
{}
],
"labels": [
"<string>"
],
"metadata": {},
"parts": [
{}
],
"s3Key": "<string>",
"statusId": "<string>",
"uploadId": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete"
payload = {
"documentVersion": "<string>",
"externalData": {},
"extraFields": {},
"filename": "<string>",
"knowledgeFeatures": [{}],
"labels": ["<string>"],
"metadata": {},
"parts": [{}],
"s3Key": "<string>",
"statusId": "<string>",
"uploadId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
documentVersion: '<string>',
externalData: {},
extraFields: {},
filename: '<string>',
knowledgeFeatures: [{}],
labels: ['<string>'],
metadata: {},
parts: [{}],
s3Key: '<string>',
statusId: '<string>',
uploadId: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete', 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://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete",
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([
'documentVersion' => '<string>',
'externalData' => [
],
'extraFields' => [
],
'filename' => '<string>',
'knowledgeFeatures' => [
[
]
],
'labels' => [
'<string>'
],
'metadata' => [
],
'parts' => [
[
]
],
's3Key' => '<string>',
'statusId' => '<string>',
'uploadId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete"
payload := strings.NewReader("{\n \"documentVersion\": \"<string>\",\n \"externalData\": {},\n \"extraFields\": {},\n \"filename\": \"<string>\",\n \"knowledgeFeatures\": [\n {}\n ],\n \"labels\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"parts\": [\n {}\n ],\n \"s3Key\": \"<string>\",\n \"statusId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"documentVersion\": \"<string>\",\n \"externalData\": {},\n \"extraFields\": {},\n \"filename\": \"<string>\",\n \"knowledgeFeatures\": [\n {}\n ],\n \"labels\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"parts\": [\n {}\n ],\n \"s3Key\": \"<string>\",\n \"statusId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"documentVersion\": \"<string>\",\n \"externalData\": {},\n \"extraFields\": {},\n \"filename\": \"<string>\",\n \"knowledgeFeatures\": [\n {}\n ],\n \"labels\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"parts\": [\n {}\n ],\n \"s3Key\": \"<string>\",\n \"statusId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}Intake
Complete a multipart intake upload
Finalises a multipart intake upload and processes the assembled file through the intake pipeline.
POST
/
api
/
intake
/
{orgSlug}
/
{intakeSlug}
/
multipart-upload-complete
Complete a multipart intake upload
curl --request POST \
--url https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"documentVersion": "<string>",
"externalData": {},
"extraFields": {},
"filename": "<string>",
"knowledgeFeatures": [
{}
],
"labels": [
"<string>"
],
"metadata": {},
"parts": [
{}
],
"s3Key": "<string>",
"statusId": "<string>",
"uploadId": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete"
payload = {
"documentVersion": "<string>",
"externalData": {},
"extraFields": {},
"filename": "<string>",
"knowledgeFeatures": [{}],
"labels": ["<string>"],
"metadata": {},
"parts": [{}],
"s3Key": "<string>",
"statusId": "<string>",
"uploadId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
documentVersion: '<string>',
externalData: {},
extraFields: {},
filename: '<string>',
knowledgeFeatures: [{}],
labels: ['<string>'],
metadata: {},
parts: [{}],
s3Key: '<string>',
statusId: '<string>',
uploadId: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete', 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://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete",
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([
'documentVersion' => '<string>',
'externalData' => [
],
'extraFields' => [
],
'filename' => '<string>',
'knowledgeFeatures' => [
[
]
],
'labels' => [
'<string>'
],
'metadata' => [
],
'parts' => [
[
]
],
's3Key' => '<string>',
'statusId' => '<string>',
'uploadId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete"
payload := strings.NewReader("{\n \"documentVersion\": \"<string>\",\n \"externalData\": {},\n \"extraFields\": {},\n \"filename\": \"<string>\",\n \"knowledgeFeatures\": [\n {}\n ],\n \"labels\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"parts\": [\n {}\n ],\n \"s3Key\": \"<string>\",\n \"statusId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"documentVersion\": \"<string>\",\n \"externalData\": {},\n \"extraFields\": {},\n \"filename\": \"<string>\",\n \"knowledgeFeatures\": [\n {}\n ],\n \"labels\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"parts\": [\n {}\n ],\n \"s3Key\": \"<string>\",\n \"statusId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/multipart-upload-complete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"documentVersion\": \"<string>\",\n \"externalData\": {},\n \"extraFields\": {},\n \"filename\": \"<string>\",\n \"knowledgeFeatures\": [\n {}\n ],\n \"labels\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"parts\": [\n {}\n ],\n \"s3Key\": \"<string>\",\n \"statusId\": \"<string>\",\n \"uploadId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
application/json
Response
Document family + validation result
The response is of type object.
⌘I
