Create Upload
curl --request POST \
--url https://api.example.com/v1/uploads \
--header 'Content-Type: application/json' \
--data '
{
"filename": "<string>",
"size_bytes": 123,
"matching": {
"coverage": "full",
"covered_competitors": [
"<string>"
],
"allow_large_removal": false
}
}
'import requests
url = "https://api.example.com/v1/uploads"
payload = {
"filename": "<string>",
"size_bytes": 123,
"matching": {
"coverage": "full",
"covered_competitors": ["<string>"],
"allow_large_removal": False
}
}
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({
filename: '<string>',
size_bytes: 123,
matching: {
coverage: 'full',
covered_competitors: ['<string>'],
allow_large_removal: false
}
})
};
fetch('https://api.example.com/v1/uploads', 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/v1/uploads",
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([
'filename' => '<string>',
'size_bytes' => 123,
'matching' => [
'coverage' => 'full',
'covered_competitors' => [
'<string>'
],
'allow_large_removal' => false
]
]),
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/v1/uploads"
payload := strings.NewReader("{\n \"filename\": \"<string>\",\n \"size_bytes\": 123,\n \"matching\": {\n \"coverage\": \"full\",\n \"covered_competitors\": [\n \"<string>\"\n ],\n \"allow_large_removal\": false\n }\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/v1/uploads")
.header("Content-Type", "application/json")
.body("{\n \"filename\": \"<string>\",\n \"size_bytes\": 123,\n \"matching\": {\n \"coverage\": \"full\",\n \"covered_competitors\": [\n \"<string>\"\n ],\n \"allow_large_removal\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/uploads")
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 \"filename\": \"<string>\",\n \"size_bytes\": 123,\n \"matching\": {\n \"coverage\": \"full\",\n \"covered_competitors\": [\n \"<string>\"\n ],\n \"allow_large_removal\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"upload_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"complete_path": "<string>",
"chunk_size_bytes": 8388608
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}imports
Create Upload
Create a 24-hour upload. PUT file chunks to upload_url using Content-Range, then complete.
POST
/
v1
/
uploads
Create Upload
curl --request POST \
--url https://api.example.com/v1/uploads \
--header 'Content-Type: application/json' \
--data '
{
"filename": "<string>",
"size_bytes": 123,
"matching": {
"coverage": "full",
"covered_competitors": [
"<string>"
],
"allow_large_removal": false
}
}
'import requests
url = "https://api.example.com/v1/uploads"
payload = {
"filename": "<string>",
"size_bytes": 123,
"matching": {
"coverage": "full",
"covered_competitors": ["<string>"],
"allow_large_removal": False
}
}
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({
filename: '<string>',
size_bytes: 123,
matching: {
coverage: 'full',
covered_competitors: ['<string>'],
allow_large_removal: false
}
})
};
fetch('https://api.example.com/v1/uploads', 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/v1/uploads",
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([
'filename' => '<string>',
'size_bytes' => 123,
'matching' => [
'coverage' => 'full',
'covered_competitors' => [
'<string>'
],
'allow_large_removal' => false
]
]),
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/v1/uploads"
payload := strings.NewReader("{\n \"filename\": \"<string>\",\n \"size_bytes\": 123,\n \"matching\": {\n \"coverage\": \"full\",\n \"covered_competitors\": [\n \"<string>\"\n ],\n \"allow_large_removal\": false\n }\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/v1/uploads")
.header("Content-Type", "application/json")
.body("{\n \"filename\": \"<string>\",\n \"size_bytes\": 123,\n \"matching\": {\n \"coverage\": \"full\",\n \"covered_competitors\": [\n \"<string>\"\n ],\n \"allow_large_removal\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/uploads")
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 \"filename\": \"<string>\",\n \"size_bytes\": 123,\n \"matching\": {\n \"coverage\": \"full\",\n \"covered_competitors\": [\n \"<string>\"\n ],\n \"allow_large_removal\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"upload_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"complete_path": "<string>",
"chunk_size_bytes": 8388608
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json

