Skip to main content
POST
/
api
/
intake
/
{orgSlug}
/
{intakeSlug}
/
presigned-upload-request
Request a presigned upload URL via intake
curl --request POST \
  --url https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/presigned-upload-request \
  --header 'x-api-key: <api-key>'
import requests

url = "https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/presigned-upload-request"

headers = {"x-api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/presigned-upload-request', 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}/presigned-upload-request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/presigned-upload-request"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("x-api-key", "<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://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/presigned-upload-request")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/intake/{orgSlug}/{intakeSlug}/presigned-upload-request")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "expiresAt": "2023-11-07T05:31:56Z",
  "s3Key": "<string>",
  "uploadId": "<string>",
  "uploadUrl": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

orgSlug
string
required

Organisation slug.

intakeSlug
string
required

Intake slug.

Query Parameters

path
string

Optional target path/filename hint.

contentType
string

MIME type of the upload.

contentLength
integer

Total content length in bytes.

Response

Presigned upload response

expiresAt
string<date-time>
s3Key
string
uploadId
string
uploadUrl
string