Prepare Asset Upload
curl --request POST \
--url https://api.example.com/api/public/v1/instructions/assets/prepare \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "<string>",
"filename": "<string>",
"mimeType": "<string>",
"sizeBytes": 123,
"sha256": "<string>",
"kind": "<string>"
}
'import requests
url = "https://api.example.com/api/public/v1/instructions/assets/prepare"
payload = {
"workspaceId": "<string>",
"filename": "<string>",
"mimeType": "<string>",
"sizeBytes": 123,
"sha256": "<string>",
"kind": "<string>"
}
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({
workspaceId: '<string>',
filename: '<string>',
mimeType: '<string>',
sizeBytes: 123,
sha256: '<string>',
kind: '<string>'
})
};
fetch('https://api.example.com/api/public/v1/instructions/assets/prepare', 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/api/public/v1/instructions/assets/prepare",
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([
'workspaceId' => '<string>',
'filename' => '<string>',
'mimeType' => '<string>',
'sizeBytes' => 123,
'sha256' => '<string>',
'kind' => '<string>'
]),
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/api/public/v1/instructions/assets/prepare"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 123,\n \"sha256\": \"<string>\",\n \"kind\": \"<string>\"\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/api/public/v1/instructions/assets/prepare")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 123,\n \"sha256\": \"<string>\",\n \"kind\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/v1/instructions/assets/prepare")
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 \"workspaceId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 123,\n \"sha256\": \"<string>\",\n \"kind\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"asset": {},
"upload": {}
}Instructions
Prepare Asset Upload
Start a private media upload: declare metadata, receive a signed PUT target.
POST
/
api
/
public
/
v1
/
instructions
/
assets
/
prepare
Prepare Asset Upload
curl --request POST \
--url https://api.example.com/api/public/v1/instructions/assets/prepare \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "<string>",
"filename": "<string>",
"mimeType": "<string>",
"sizeBytes": 123,
"sha256": "<string>",
"kind": "<string>"
}
'import requests
url = "https://api.example.com/api/public/v1/instructions/assets/prepare"
payload = {
"workspaceId": "<string>",
"filename": "<string>",
"mimeType": "<string>",
"sizeBytes": 123,
"sha256": "<string>",
"kind": "<string>"
}
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({
workspaceId: '<string>',
filename: '<string>',
mimeType: '<string>',
sizeBytes: 123,
sha256: '<string>',
kind: '<string>'
})
};
fetch('https://api.example.com/api/public/v1/instructions/assets/prepare', 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/api/public/v1/instructions/assets/prepare",
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([
'workspaceId' => '<string>',
'filename' => '<string>',
'mimeType' => '<string>',
'sizeBytes' => 123,
'sha256' => '<string>',
'kind' => '<string>'
]),
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/api/public/v1/instructions/assets/prepare"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 123,\n \"sha256\": \"<string>\",\n \"kind\": \"<string>\"\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/api/public/v1/instructions/assets/prepare")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 123,\n \"sha256\": \"<string>\",\n \"kind\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/v1/instructions/assets/prepare")
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 \"workspaceId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"sizeBytes\": 123,\n \"sha256\": \"<string>\",\n \"kind\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"asset": {},
"upload": {}
}Starts the two-phase private upload: declare the file’s metadata and hash, receive a short-lived signed
PUT target. Upload the bytes there, then call finalize. Size limits per kind: IMAGE 25 MB, FILE 100 MB, AUDIO 250 MB, VIDEO 2 GB (confirm live values via capabilities). Canonical documents reference assets by id only — raw storage URLs are rejected at write time.
Requirements: instructions:write + workspace EDITOR or OWNER + a verified (claimed) account.
Request
string
required
The owning workspace (assets never cross workspace boundaries).
string
required
Original filename.
string
required
MIME type — also determines the default
kind.number
required
Exact byte size, checked against the per-kind limit.
string
required
Lowercase hex SHA-256 of the file bytes.
string
Override:
IMAGE, FILE, AUDIO, or VIDEO.Response
Returns201.
object
The
PENDING asset record.object
{url, method: "PUT", headers, expiresAt} — send the raw bytes to url with the given headers before expiresAt.⌘I