Asset sessions
Create an asset session
POST
/
v1
/
studios
/
{studio_id}
/
asset-sessions
Create an asset session
curl --request POST \
--url https://api.batchrelay.com/v1/studios/{studio_id}/asset-sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"assets": [
{
"byte_count": 49807360,
"client_local_id": "<string>",
"display_filename": "<string>",
"sha256": "<string>",
"alt_text": "<string>",
"pixel_height": 2,
"pixel_width": 2,
"source_url": "<string>"
}
],
"destination_id": "<string>",
"destination_type": "<string>",
"purpose": "<string>"
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/asset-sessions"
payload = {
"assets": [
{
"byte_count": 49807360,
"client_local_id": "<string>",
"display_filename": "<string>",
"sha256": "<string>",
"alt_text": "<string>",
"pixel_height": 2,
"pixel_width": 2,
"source_url": "<string>"
}
],
"destination_id": "<string>",
"destination_type": "<string>",
"purpose": "<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({
assets: [
{
byte_count: 49807360,
client_local_id: '<string>',
display_filename: '<string>',
sha256: '<string>',
alt_text: '<string>',
pixel_height: 2,
pixel_width: 2,
source_url: '<string>'
}
],
destination_id: '<string>',
destination_type: '<string>',
purpose: '<string>'
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/asset-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/studios/{studio_id}/asset-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([
'assets' => [
[
'byte_count' => 49807360,
'client_local_id' => '<string>',
'display_filename' => '<string>',
'sha256' => '<string>',
'alt_text' => '<string>',
'pixel_height' => 2,
'pixel_width' => 2,
'source_url' => '<string>'
]
],
'destination_id' => '<string>',
'destination_type' => '<string>',
'purpose' => '<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/studios/{studio_id}/asset-sessions"
payload := strings.NewReader("{\n \"assets\": [\n {\n \"byte_count\": 49807360,\n \"client_local_id\": \"<string>\",\n \"display_filename\": \"<string>\",\n \"sha256\": \"<string>\",\n \"alt_text\": \"<string>\",\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"source_url\": \"<string>\"\n }\n ],\n \"destination_id\": \"<string>\",\n \"destination_type\": \"<string>\",\n \"purpose\": \"<string>\"\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/studios/{studio_id}/asset-sessions")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"assets\": [\n {\n \"byte_count\": 49807360,\n \"client_local_id\": \"<string>\",\n \"display_filename\": \"<string>\",\n \"sha256\": \"<string>\",\n \"alt_text\": \"<string>\",\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"source_url\": \"<string>\"\n }\n ],\n \"destination_id\": \"<string>\",\n \"destination_type\": \"<string>\",\n \"purpose\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/asset-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 \"assets\": [\n {\n \"byte_count\": 49807360,\n \"client_local_id\": \"<string>\",\n \"display_filename\": \"<string>\",\n \"sha256\": \"<string>\",\n \"alt_text\": \"<string>\",\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"source_url\": \"<string>\"\n }\n ],\n \"destination_id\": \"<string>\",\n \"destination_type\": \"<string>\",\n \"purpose\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"assets": [
{
"asset_id": "<string>",
"byte_count": 123,
"client_local_id": "<string>",
"display_filename": "<string>",
"disposition": "<string>",
"media_type": "<string>",
"sha256": "<string>",
"status": "<string>",
"alt_text": "<string>",
"pixel_height": 123,
"pixel_width": 123
}
],
"destination_id": "<string>",
"destination_type": "<string>",
"id": "<string>",
"purpose": "<string>",
"revision": 2,
"status": "<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
Required string length:
1 - 200Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.
Required string length:
1 - 100Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.
Required string length:
1 - 100Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.
Required string length:
1 - 100Path Parameters
Stable public studio ID beginning with stu_. The API never selects a studio implicitly; a local CLI profile name is not a studio ID.
Required string length:
5 - 256Pattern:
^stu_[A-Za-z0-9_-]+$Body
application/json
Response
Asset session
⌘I
Create an asset session
curl --request POST \
--url https://api.batchrelay.com/v1/studios/{studio_id}/asset-sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"assets": [
{
"byte_count": 49807360,
"client_local_id": "<string>",
"display_filename": "<string>",
"sha256": "<string>",
"alt_text": "<string>",
"pixel_height": 2,
"pixel_width": 2,
"source_url": "<string>"
}
],
"destination_id": "<string>",
"destination_type": "<string>",
"purpose": "<string>"
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/asset-sessions"
payload = {
"assets": [
{
"byte_count": 49807360,
"client_local_id": "<string>",
"display_filename": "<string>",
"sha256": "<string>",
"alt_text": "<string>",
"pixel_height": 2,
"pixel_width": 2,
"source_url": "<string>"
}
],
"destination_id": "<string>",
"destination_type": "<string>",
"purpose": "<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({
assets: [
{
byte_count: 49807360,
client_local_id: '<string>',
display_filename: '<string>',
sha256: '<string>',
alt_text: '<string>',
pixel_height: 2,
pixel_width: 2,
source_url: '<string>'
}
],
destination_id: '<string>',
destination_type: '<string>',
purpose: '<string>'
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/asset-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/studios/{studio_id}/asset-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([
'assets' => [
[
'byte_count' => 49807360,
'client_local_id' => '<string>',
'display_filename' => '<string>',
'sha256' => '<string>',
'alt_text' => '<string>',
'pixel_height' => 2,
'pixel_width' => 2,
'source_url' => '<string>'
]
],
'destination_id' => '<string>',
'destination_type' => '<string>',
'purpose' => '<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/studios/{studio_id}/asset-sessions"
payload := strings.NewReader("{\n \"assets\": [\n {\n \"byte_count\": 49807360,\n \"client_local_id\": \"<string>\",\n \"display_filename\": \"<string>\",\n \"sha256\": \"<string>\",\n \"alt_text\": \"<string>\",\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"source_url\": \"<string>\"\n }\n ],\n \"destination_id\": \"<string>\",\n \"destination_type\": \"<string>\",\n \"purpose\": \"<string>\"\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/studios/{studio_id}/asset-sessions")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"assets\": [\n {\n \"byte_count\": 49807360,\n \"client_local_id\": \"<string>\",\n \"display_filename\": \"<string>\",\n \"sha256\": \"<string>\",\n \"alt_text\": \"<string>\",\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"source_url\": \"<string>\"\n }\n ],\n \"destination_id\": \"<string>\",\n \"destination_type\": \"<string>\",\n \"purpose\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/asset-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 \"assets\": [\n {\n \"byte_count\": 49807360,\n \"client_local_id\": \"<string>\",\n \"display_filename\": \"<string>\",\n \"sha256\": \"<string>\",\n \"alt_text\": \"<string>\",\n \"pixel_height\": 2,\n \"pixel_width\": 2,\n \"source_url\": \"<string>\"\n }\n ],\n \"destination_id\": \"<string>\",\n \"destination_type\": \"<string>\",\n \"purpose\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"assets": [
{
"asset_id": "<string>",
"byte_count": 123,
"client_local_id": "<string>",
"display_filename": "<string>",
"disposition": "<string>",
"media_type": "<string>",
"sha256": "<string>",
"status": "<string>",
"alt_text": "<string>",
"pixel_height": 123,
"pixel_width": 123
}
],
"destination_id": "<string>",
"destination_type": "<string>",
"id": "<string>",
"purpose": "<string>",
"revision": 2,
"status": "<string>"
}