Launch Creation
curl --request POST \
--url https://api.example.com/api/v1/brands/{brand_id}/creative/creations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"flow": "image_ad",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"product_url": "<string>",
"source_creative_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_variant_index": 0,
"source_upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_ad_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"board_ad_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"group_advertiser_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"gap_theme": "<string>",
"source_post_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_label": "<string>",
"set_size": 12,
"aspect_ratio": "1:1",
"platform": "<string>",
"hook": "<string>",
"instructions": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/creative/creations"
payload = {
"flow": "image_ad",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"product_url": "<string>",
"source_creative_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_variant_index": 0,
"source_upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_ad_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"board_ad_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"group_advertiser_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"gap_theme": "<string>",
"source_post_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_label": "<string>",
"set_size": 12,
"aspect_ratio": "1:1",
"platform": "<string>",
"hook": "<string>",
"instructions": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
flow: 'image_ad',
product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
product_url: '<string>',
source_creative_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source_variant_index: 0,
source_upload_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source_ad_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
board_ad_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
group_advertiser_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
gap_theme: '<string>',
source_post_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source_label: '<string>',
set_size: 12,
aspect_ratio: '1:1',
platform: '<string>',
hook: '<string>',
instructions: '<string>'
})
};
fetch('https://api.example.com/api/v1/brands/{brand_id}/creative/creations', 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/v1/brands/{brand_id}/creative/creations",
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([
'flow' => 'image_ad',
'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'product_url' => '<string>',
'source_creative_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source_variant_index' => 0,
'source_upload_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source_ad_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'board_ad_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'group_advertiser_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'gap_theme' => '<string>',
'source_post_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source_label' => '<string>',
'set_size' => 12,
'aspect_ratio' => '1:1',
'platform' => '<string>',
'hook' => '<string>',
'instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/v1/brands/{brand_id}/creative/creations"
payload := strings.NewReader("{\n \"flow\": \"image_ad\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"product_url\": \"<string>\",\n \"source_creative_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_variant_index\": 0,\n \"source_upload_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_ad_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"board_ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"group_advertiser_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"gap_theme\": \"<string>\",\n \"source_post_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_label\": \"<string>\",\n \"set_size\": 12,\n \"aspect_ratio\": \"1:1\",\n \"platform\": \"<string>\",\n \"hook\": \"<string>\",\n \"instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/brands/{brand_id}/creative/creations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"flow\": \"image_ad\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"product_url\": \"<string>\",\n \"source_creative_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_variant_index\": 0,\n \"source_upload_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_ad_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"board_ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"group_advertiser_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"gap_theme\": \"<string>\",\n \"source_post_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_label\": \"<string>\",\n \"set_size\": 12,\n \"aspect_ratio\": \"1:1\",\n \"platform\": \"<string>\",\n \"hook\": \"<string>\",\n \"instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/creative/creations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"flow\": \"image_ad\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"product_url\": \"<string>\",\n \"source_creative_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_variant_index\": 0,\n \"source_upload_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_ad_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"board_ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"group_advertiser_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"gap_theme\": \"<string>\",\n \"source_post_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_label\": \"<string>\",\n \"set_size\": 12,\n \"aspect_ratio\": \"1:1\",\n \"platform\": \"<string>\",\n \"hook\": \"<string>\",\n \"instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"flow": "<string>",
"status": "<string>",
"source_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"source_label": "<string>",
"aspect_ratio": "<string>",
"platform": "<string>",
"asset_count": 0,
"preview_url": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Brand Creative
Launch Creation
Start a creation run (202 — renders happen off-request).
Returns the queued run immediately; the client polls the library for its variants. Every guardrail (flow support, source validity, daily quota, per-run cost ceiling) runs BEFORE anything is persisted, so a rejected launch leaves no ghost row behind.
POST
/
api
/
v1
/
brands
/
{brand_id}
/
creative
/
creations
Launch Creation
curl --request POST \
--url https://api.example.com/api/v1/brands/{brand_id}/creative/creations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"flow": "image_ad",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"product_url": "<string>",
"source_creative_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_variant_index": 0,
"source_upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_ad_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"board_ad_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"group_advertiser_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"gap_theme": "<string>",
"source_post_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_label": "<string>",
"set_size": 12,
"aspect_ratio": "1:1",
"platform": "<string>",
"hook": "<string>",
"instructions": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/creative/creations"
payload = {
"flow": "image_ad",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"product_url": "<string>",
"source_creative_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_variant_index": 0,
"source_upload_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_ad_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"board_ad_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"group_advertiser_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"gap_theme": "<string>",
"source_post_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_label": "<string>",
"set_size": 12,
"aspect_ratio": "1:1",
"platform": "<string>",
"hook": "<string>",
"instructions": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
flow: 'image_ad',
product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
product_url: '<string>',
source_creative_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source_variant_index: 0,
source_upload_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source_ad_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
board_ad_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
group_advertiser_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
gap_theme: '<string>',
source_post_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source_label: '<string>',
set_size: 12,
aspect_ratio: '1:1',
platform: '<string>',
hook: '<string>',
instructions: '<string>'
})
};
fetch('https://api.example.com/api/v1/brands/{brand_id}/creative/creations', 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/v1/brands/{brand_id}/creative/creations",
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([
'flow' => 'image_ad',
'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'product_url' => '<string>',
'source_creative_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source_variant_index' => 0,
'source_upload_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source_ad_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'board_ad_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'group_advertiser_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'gap_theme' => '<string>',
'source_post_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source_label' => '<string>',
'set_size' => 12,
'aspect_ratio' => '1:1',
'platform' => '<string>',
'hook' => '<string>',
'instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/v1/brands/{brand_id}/creative/creations"
payload := strings.NewReader("{\n \"flow\": \"image_ad\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"product_url\": \"<string>\",\n \"source_creative_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_variant_index\": 0,\n \"source_upload_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_ad_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"board_ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"group_advertiser_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"gap_theme\": \"<string>\",\n \"source_post_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_label\": \"<string>\",\n \"set_size\": 12,\n \"aspect_ratio\": \"1:1\",\n \"platform\": \"<string>\",\n \"hook\": \"<string>\",\n \"instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/brands/{brand_id}/creative/creations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"flow\": \"image_ad\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"product_url\": \"<string>\",\n \"source_creative_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_variant_index\": 0,\n \"source_upload_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_ad_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"board_ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"group_advertiser_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"gap_theme\": \"<string>\",\n \"source_post_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_label\": \"<string>\",\n \"set_size\": 12,\n \"aspect_ratio\": \"1:1\",\n \"platform\": \"<string>\",\n \"hook\": \"<string>\",\n \"instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/creative/creations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"flow\": \"image_ad\",\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"product_url\": \"<string>\",\n \"source_creative_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_variant_index\": 0,\n \"source_upload_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_ad_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"board_ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"group_advertiser_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"gap_theme\": \"<string>\",\n \"source_post_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_label\": \"<string>\",\n \"set_size\": 12,\n \"aspect_ratio\": \"1:1\",\n \"platform\": \"<string>\",\n \"hook\": \"<string>\",\n \"instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"flow": "<string>",
"status": "<string>",
"source_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"source_label": "<string>",
"aspect_ratio": "<string>",
"platform": "<string>",
"asset_count": 0,
"preview_url": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Start a Create run.
The launch route validates flow against the orchestrator's
IMPLEMENTED_FLOWS, so a flow whose runner hasn't shipped is rejected at
the boundary rather than enqueued into a lane that would fail it.
Sources come in two shapes and the flow decides which it needs:
- Product-sourced (
image_ad,video_ad,slideshow_ad,photoshoot) — a saved product carries catalogue data; a URL carries only what the user typed, soinstructionsmatters more there. - Asset-sourced (
iterate,reframe,restage— B7's edit flows) — an image the user already has: one variant of a prior creation, or an upload. The launcher resolves it to a storage key and ownership-checks it; there is no product lookup, because an edit works from the picture.
Sending a product to an edit flow (or an asset to a product flow) is a 400 with copy naming what that flow actually needs — NOT a silent fallback, since the two produce completely different output.
Maximum string length:
2048Required range:
x >= 0Maximum array length:
200Maximum array length:
60Maximum string length:
60Maximum string length:
120Required range:
1 <= x <= 24Maximum string length:
40Maximum string length:
300Maximum string length:
1000Response
Successful Response
A card in the My Creations grid.
Was this page helpful?
⌘I