Skip to main content
POST
/
documents
Generate upload URL
curl --request POST \
  --url https://api.example.com/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "test": true
}
'
import requests

url = "https://api.example.com/documents"

payload = {
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"name": "<string>",
"test": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({metadata: [{key: '<string>', value: '<string>'}], name: '<string>', test: true})
};

fetch('https://api.example.com/documents', 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://api.example.com/documents",
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([
'metadata' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'name' => '<string>',
'test' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$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://api.example.com/documents"

payload := strings.NewReader("{\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"test\": true\n}")

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

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://api.example.com/documents")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"test\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/documents")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"test\": true\n}"

response = http.request(request)
puts response.read_body
{
  "url": "<string>",
  "id": "<string>"
}

Body

application/json
metadata
object[]
required

metadata assigned to the object

name
string
required

the name of the document

test
boolean

is it a test customer

Response

200 - application/json
url
string
required

the signed url to upload the document

id
string
required

the id of the document