Template renders
Create a render from a published template
Requires a studio-owned API account with template_renders:write. During the compatibility period, print_orders:write is also accepted. Accepts explicit stable slot IDs only. Omit revision_id to resolve the latest published revision; the response snapshots the resolved immutable revision. The service does not infer input order or fetch arbitrary caller URLs. Convex durably queues this job; the local API does not embed or dispatch the private renderer.
POST
/
v1
/
templates
/
{template_id}
/
renders
Create a render from a published template
curl --request POST \
--url https://api.batchrelay.com/v1/templates/{template_id}/renders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"inputs": {},
"output_id": "<string>",
"revision_id": "<string>"
}
'import requests
url = "https://api.batchrelay.com/v1/templates/{template_id}/renders"
payload = {
"inputs": {},
"output_id": "<string>",
"revision_id": "<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({inputs: {}, output_id: '<string>', revision_id: '<string>'})
};
fetch('https://api.batchrelay.com/v1/templates/{template_id}/renders', 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/templates/{template_id}/renders",
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([
'inputs' => [
],
'output_id' => '<string>',
'revision_id' => '<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/templates/{template_id}/renders"
payload := strings.NewReader("{\n \"inputs\": {},\n \"output_id\": \"<string>\",\n \"revision_id\": \"<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/templates/{template_id}/renders")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": {},\n \"output_id\": \"<string>\",\n \"revision_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/templates/{template_id}/renders")
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 \"inputs\": {},\n \"output_id\": \"<string>\",\n \"revision_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"artifacts": [
{
"asset_id": "<string>",
"fulfillment_role": "artwork",
"pixel_height": 2,
"pixel_width": 2,
"surface_id": "<string>",
"resolved_orientation": "north",
"sha256": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"output_id": "<string>",
"render_id": "<string>",
"status": "queued",
"template": {
"id": "<string>",
"revision_id": "<string>",
"template_engine_version": "0.10.0",
"document_hash": "<string>"
},
"updated_at": "2023-11-07T05:31:56Z"
}{
"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
Retries with the same key return the durable render job; reuse with a different request returns idempotency_conflict.
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
Minimum string length:
1Body
application/json
Explicit stable slot ID to value mapping. Labels and positional order are never interpreted by the API.
Show child attributes
Show child attributes
A published one- or multi-surface output selector, such as print-8x10-portrait or trader-card-double-sided. It owns the selected surface variants.
Optional immutable template revision. When omitted, Batch Relay resolves the latest published revision and returns it in template.revision_id.
Response
Render queued, running, succeeded, or failed. Artifacts are always an array so multi-surface output is representable.
Show child attributes
Show child attributes
Available options:
queued, running, succeeded, failed, cancelled Show child attributes
Show child attributes
⌘I
Create a render from a published template
curl --request POST \
--url https://api.batchrelay.com/v1/templates/{template_id}/renders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"inputs": {},
"output_id": "<string>",
"revision_id": "<string>"
}
'import requests
url = "https://api.batchrelay.com/v1/templates/{template_id}/renders"
payload = {
"inputs": {},
"output_id": "<string>",
"revision_id": "<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({inputs: {}, output_id: '<string>', revision_id: '<string>'})
};
fetch('https://api.batchrelay.com/v1/templates/{template_id}/renders', 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/templates/{template_id}/renders",
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([
'inputs' => [
],
'output_id' => '<string>',
'revision_id' => '<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/templates/{template_id}/renders"
payload := strings.NewReader("{\n \"inputs\": {},\n \"output_id\": \"<string>\",\n \"revision_id\": \"<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/templates/{template_id}/renders")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": {},\n \"output_id\": \"<string>\",\n \"revision_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/templates/{template_id}/renders")
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 \"inputs\": {},\n \"output_id\": \"<string>\",\n \"revision_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"artifacts": [
{
"asset_id": "<string>",
"fulfillment_role": "artwork",
"pixel_height": 2,
"pixel_width": 2,
"surface_id": "<string>",
"resolved_orientation": "north",
"sha256": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"output_id": "<string>",
"render_id": "<string>",
"status": "queued",
"template": {
"id": "<string>",
"revision_id": "<string>",
"template_engine_version": "0.10.0",
"document_hash": "<string>"
},
"updated_at": "2023-11-07T05:31:56Z"
}{
"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>"
}