Create an event image import
curl --request POST \
--url https://api.batchrelay.com/v1/studios/{studio_id}/events/{event_id}/image-imports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"manifest": {
"kind": "staged",
"entries": [
{
"asset_id": "<string>",
"client_local_id": "<string>",
"filename": "<string>",
"subject_key": "<string>"
}
]
},
"asset_session_id": "<string>",
"expected_session_revision": 2,
"mapping_csv": "<string>"
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/events/{event_id}/image-imports"
payload = {
"manifest": {
"kind": "staged",
"entries": [
{
"asset_id": "<string>",
"client_local_id": "<string>",
"filename": "<string>",
"subject_key": "<string>"
}
]
},
"asset_session_id": "<string>",
"expected_session_revision": 2,
"mapping_csv": "<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({
manifest: {
kind: 'staged',
entries: [
{
asset_id: '<string>',
client_local_id: '<string>',
filename: '<string>',
subject_key: '<string>'
}
]
},
asset_session_id: '<string>',
expected_session_revision: 2,
mapping_csv: '<string>'
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/events/{event_id}/image-imports', 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}/events/{event_id}/image-imports",
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([
'manifest' => [
'kind' => 'staged',
'entries' => [
[
'asset_id' => '<string>',
'client_local_id' => '<string>',
'filename' => '<string>',
'subject_key' => '<string>'
]
]
],
'asset_session_id' => '<string>',
'expected_session_revision' => 2,
'mapping_csv' => '<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}/events/{event_id}/image-imports"
payload := strings.NewReader("{\n \"manifest\": {\n \"kind\": \"staged\",\n \"entries\": [\n {\n \"asset_id\": \"<string>\",\n \"client_local_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"subject_key\": \"<string>\"\n }\n ]\n },\n \"asset_session_id\": \"<string>\",\n \"expected_session_revision\": 2,\n \"mapping_csv\": \"<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}/events/{event_id}/image-imports")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": {\n \"kind\": \"staged\",\n \"entries\": [\n {\n \"asset_id\": \"<string>\",\n \"client_local_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"subject_key\": \"<string>\"\n }\n ]\n },\n \"asset_session_id\": \"<string>\",\n \"expected_session_revision\": 2,\n \"mapping_csv\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/events/{event_id}/image-imports")
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 \"manifest\": {\n \"kind\": \"staged\",\n \"entries\": [\n {\n \"asset_id\": \"<string>\",\n \"client_local_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"subject_key\": \"<string>\"\n }\n ]\n },\n \"asset_session_id\": \"<string>\",\n \"expected_session_revision\": 2,\n \"mapping_csv\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"duplicates": [
"<string>"
],
"id": "<string>",
"missing_files": [
"<string>"
],
"proposed_bindings": [
{
"asset_id": "<string>",
"confidence": "<string>",
"subject_key": "<string>"
}
],
"resolution_diagnostics": [
{
"effective_ppi": 123,
"grade": "ready",
"message": "<string>",
"output": "<string>",
"output_inches": {
"height": 123,
"width": 123
},
"source_pixels": {
"height": 123,
"width": 123
},
"acknowledgement": {
"acknowledged_at": 123,
"policy_version": "<string>",
"reason": "<string>"
}
}
],
"revision": 2,
"status": "<string>",
"unresolved": [
"<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 - 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.
5 - 256^stu_[A-Za-z0-9_-]+$1 - 256Body
- Option 1
- Option 2
Show child attributes
Show child attributes
Asset-session revision returned by the authoritative AssetSession response.
x >= 11048576Required exactly when manifest.kind is smart_crop_masters_preview; forbidden for staged. Its camelCase fields are the frozen Xcode Smart Crop V2 document.
Show child attributes
Show child attributes
Response
Image import
curl --request POST \
--url https://api.batchrelay.com/v1/studios/{studio_id}/events/{event_id}/image-imports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"manifest": {
"kind": "staged",
"entries": [
{
"asset_id": "<string>",
"client_local_id": "<string>",
"filename": "<string>",
"subject_key": "<string>"
}
]
},
"asset_session_id": "<string>",
"expected_session_revision": 2,
"mapping_csv": "<string>"
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/events/{event_id}/image-imports"
payload = {
"manifest": {
"kind": "staged",
"entries": [
{
"asset_id": "<string>",
"client_local_id": "<string>",
"filename": "<string>",
"subject_key": "<string>"
}
]
},
"asset_session_id": "<string>",
"expected_session_revision": 2,
"mapping_csv": "<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({
manifest: {
kind: 'staged',
entries: [
{
asset_id: '<string>',
client_local_id: '<string>',
filename: '<string>',
subject_key: '<string>'
}
]
},
asset_session_id: '<string>',
expected_session_revision: 2,
mapping_csv: '<string>'
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/events/{event_id}/image-imports', 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}/events/{event_id}/image-imports",
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([
'manifest' => [
'kind' => 'staged',
'entries' => [
[
'asset_id' => '<string>',
'client_local_id' => '<string>',
'filename' => '<string>',
'subject_key' => '<string>'
]
]
],
'asset_session_id' => '<string>',
'expected_session_revision' => 2,
'mapping_csv' => '<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}/events/{event_id}/image-imports"
payload := strings.NewReader("{\n \"manifest\": {\n \"kind\": \"staged\",\n \"entries\": [\n {\n \"asset_id\": \"<string>\",\n \"client_local_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"subject_key\": \"<string>\"\n }\n ]\n },\n \"asset_session_id\": \"<string>\",\n \"expected_session_revision\": 2,\n \"mapping_csv\": \"<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}/events/{event_id}/image-imports")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": {\n \"kind\": \"staged\",\n \"entries\": [\n {\n \"asset_id\": \"<string>\",\n \"client_local_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"subject_key\": \"<string>\"\n }\n ]\n },\n \"asset_session_id\": \"<string>\",\n \"expected_session_revision\": 2,\n \"mapping_csv\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/events/{event_id}/image-imports")
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 \"manifest\": {\n \"kind\": \"staged\",\n \"entries\": [\n {\n \"asset_id\": \"<string>\",\n \"client_local_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"subject_key\": \"<string>\"\n }\n ]\n },\n \"asset_session_id\": \"<string>\",\n \"expected_session_revision\": 2,\n \"mapping_csv\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"duplicates": [
"<string>"
],
"id": "<string>",
"missing_files": [
"<string>"
],
"proposed_bindings": [
{
"asset_id": "<string>",
"confidence": "<string>",
"subject_key": "<string>"
}
],
"resolution_diagnostics": [
{
"effective_ppi": 123,
"grade": "ready",
"message": "<string>",
"output": "<string>",
"output_inches": {
"height": 123,
"width": 123
},
"source_pixels": {
"height": 123,
"width": 123
},
"acknowledgement": {
"acknowledged_at": 123,
"policy_version": "<string>",
"reason": "<string>"
}
}
],
"revision": 2,
"status": "<string>",
"unresolved": [
"<string>"
]
}