Reserve a studio-scoped original-asset upload session
Requires an active studio-owned API account and the studio_assets:write scope. Each file supplies a stable local_id and its lowercase SHA-256 before any upload grant is created. Convex resolves the API key’s owner studio, reconciles matching ready bytes only within that studio and event, and returns upload_required or already_uploaded per local_id. Neither studio_id, storage bucket, nor object_key may be supplied. An identical retry with the same Idempotency-Key returns the same lifecycle binding; reuse for a different reservation conflicts.
curl --request POST \
--url https://api.batchrelay.com/v1/studio-assets/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"event_id": "<string>",
"files": [
{
"byte_size": 49807360,
"expected_sha256": "<string>",
"local_id": "<string>",
"original_filename": "<string>",
"capture_number": 1,
"display_filename": "<string>",
"md5": "<string>"
}
]
}
'import requests
url = "https://api.batchrelay.com/v1/studio-assets/sessions"
payload = {
"event_id": "<string>",
"files": [
{
"byte_size": 49807360,
"expected_sha256": "<string>",
"local_id": "<string>",
"original_filename": "<string>",
"capture_number": 1,
"display_filename": "<string>",
"md5": "<string>"
}
]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
event_id: '<string>',
files: [
{
byte_size: 49807360,
expected_sha256: '<string>',
local_id: '<string>',
original_filename: '<string>',
capture_number: 1,
display_filename: '<string>',
md5: '<string>'
}
]
})
};
fetch('https://api.batchrelay.com/v1/studio-assets/sessions', 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.batchrelay.com/v1/studio-assets/sessions",
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([
'event_id' => '<string>',
'files' => [
[
'byte_size' => 49807360,
'expected_sha256' => '<string>',
'local_id' => '<string>',
'original_filename' => '<string>',
'capture_number' => 1,
'display_filename' => '<string>',
'md5' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://api.batchrelay.com/v1/studio-assets/sessions"
payload := strings.NewReader("{\n \"event_id\": \"<string>\",\n \"files\": [\n {\n \"byte_size\": 49807360,\n \"expected_sha256\": \"<string>\",\n \"local_id\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"capture_number\": 1,\n \"display_filename\": \"<string>\",\n \"md5\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.batchrelay.com/v1/studio-assets/sessions")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"event_id\": \"<string>\",\n \"files\": [\n {\n \"byte_size\": 49807360,\n \"expected_sha256\": \"<string>\",\n \"local_id\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"capture_number\": 1,\n \"display_filename\": \"<string>\",\n \"md5\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studio-assets/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_id\": \"<string>\",\n \"files\": [\n {\n \"byte_size\": 49807360,\n \"expected_sha256\": \"<string>\",\n \"local_id\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"capture_number\": 1,\n \"display_filename\": \"<string>\",\n \"md5\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"assets": [
{
"byte_size": 2,
"content_type": "image/jpeg",
"id": "<string>",
"original_filename": "<string>",
"status": "reserved",
"upload_session_id": "<string>"
}
],
"id": "<string>",
"reconciled": [
{
"disposition": "upload_required",
"image_asset_id": "<string>",
"local_id": "<string>",
"status": "reserved"
}
],
"status": "<string>",
"counts": {}
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}Authorizations
Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.
Headers
1 - 200Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.
1 - 100Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.
1 - 100Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.
1 - 100Body
Response
Reconciled session; only reconciled entries with upload_required may be PUT
curl --request POST \
--url https://api.batchrelay.com/v1/studio-assets/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"event_id": "<string>",
"files": [
{
"byte_size": 49807360,
"expected_sha256": "<string>",
"local_id": "<string>",
"original_filename": "<string>",
"capture_number": 1,
"display_filename": "<string>",
"md5": "<string>"
}
]
}
'import requests
url = "https://api.batchrelay.com/v1/studio-assets/sessions"
payload = {
"event_id": "<string>",
"files": [
{
"byte_size": 49807360,
"expected_sha256": "<string>",
"local_id": "<string>",
"original_filename": "<string>",
"capture_number": 1,
"display_filename": "<string>",
"md5": "<string>"
}
]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
event_id: '<string>',
files: [
{
byte_size: 49807360,
expected_sha256: '<string>',
local_id: '<string>',
original_filename: '<string>',
capture_number: 1,
display_filename: '<string>',
md5: '<string>'
}
]
})
};
fetch('https://api.batchrelay.com/v1/studio-assets/sessions', 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.batchrelay.com/v1/studio-assets/sessions",
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([
'event_id' => '<string>',
'files' => [
[
'byte_size' => 49807360,
'expected_sha256' => '<string>',
'local_id' => '<string>',
'original_filename' => '<string>',
'capture_number' => 1,
'display_filename' => '<string>',
'md5' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://api.batchrelay.com/v1/studio-assets/sessions"
payload := strings.NewReader("{\n \"event_id\": \"<string>\",\n \"files\": [\n {\n \"byte_size\": 49807360,\n \"expected_sha256\": \"<string>\",\n \"local_id\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"capture_number\": 1,\n \"display_filename\": \"<string>\",\n \"md5\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.batchrelay.com/v1/studio-assets/sessions")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"event_id\": \"<string>\",\n \"files\": [\n {\n \"byte_size\": 49807360,\n \"expected_sha256\": \"<string>\",\n \"local_id\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"capture_number\": 1,\n \"display_filename\": \"<string>\",\n \"md5\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studio-assets/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_id\": \"<string>\",\n \"files\": [\n {\n \"byte_size\": 49807360,\n \"expected_sha256\": \"<string>\",\n \"local_id\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"capture_number\": 1,\n \"display_filename\": \"<string>\",\n \"md5\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"assets": [
{
"byte_size": 2,
"content_type": "image/jpeg",
"id": "<string>",
"original_filename": "<string>",
"status": "reserved",
"upload_session_id": "<string>"
}
],
"id": "<string>",
"reconciled": [
{
"disposition": "upload_required",
"image_asset_id": "<string>",
"local_id": "<string>",
"status": "reserved"
}
],
"status": "<string>",
"counts": {}
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}