MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer your-token".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your API Tokens within the AdBlast dashboard and clicking Generate API token.

Health

Health check

requires authentication

Health check endpoint for API status and authentication verification.

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Unauthenticated."
}

Request      

GET api

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

Project

List Projects

requires authentication

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{"projects": [{"id": "01H...", "title": "My Project", "slug": "my-project", ...}]}

Request      

GET api/projects

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

Create Project

requires authentication

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"\\\"AI Filmmaking\\\"\",
    \"ad_idea_prompt\": \"\\\"Create a video about AI filmmaking tools\\\"\",
    \"campaign_type\": \"Brand or Service\",
    \"visual_style\": \"Realistic 35mm Film\",
    \"length_seconds\": 60,
    \"aspect_ratio\": \"16:9\"
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "\"AI Filmmaking\"",
    "ad_idea_prompt": "\"Create a video about AI filmmaking tools\"",
    "campaign_type": "Brand or Service",
    "visual_style": "Realistic 35mm Film",
    "length_seconds": 60,
    "aspect_ratio": "16:9"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => '"AI Filmmaking"',
            'ad_idea_prompt' => '"Create a video about AI filmmaking tools"',
            'campaign_type' => 'Brand or Service',
            'visual_style' => 'Realistic 35mm Film',
            'length_seconds' => 60,
            'aspect_ratio' => '16:9',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects'
payload = {
    "title": "\"AI Filmmaking\"",
    "ad_idea_prompt": "\"Create a video about AI filmmaking tools\"",
    "campaign_type": "Brand or Service",
    "visual_style": "Realistic 35mm Film",
    "length_seconds": 60,
    "aspect_ratio": "16:9"
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (201):


{"project": {"id": "01H...", "title": "My Project", "slug": "my-project", ...}}

Example response (422, Validation failed):


{
    "error": "The title field is required."
}

Request      

POST api/projects

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

title   string     

The project title. Example: "AI Filmmaking"

ad_idea_prompt   string     

The prompt for AI to generate the ad idea. Example: "Create a video about AI filmmaking tools"

campaign_type   string     

The campaign type enum value. Example: Brand or Service

Must be one of:
  • Brand or Service
  • Personal Brand / Service / Client
  • Cinematic Short Film Story (No Product)
  • Scale Your Skool Community
visual_style   string  optional    

The visual style enum value. Example: Realistic 35mm Film

Must be one of:
  • Realistic 35mm Film
  • Oil Painting
  • Stop Frame Animation
  • CinePlastic
  • 90s Comic Book Art
  • Origami Style
  • Storybook Style
length_seconds   integer  optional    

The video length in seconds (1-600). Example: 60

aspect_ratio   string     

The aspect ratio enum value. Example: 16:9

Must be one of:
  • 9:16
  • 1:1
  • 16:9

Get Project

requires authentication

Retrieve the full project object

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


the project object

Request      

GET api/projects/{project_id}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Update Project

requires authentication

Example request:
curl --request PUT \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"\\\"AI Filmmaking\\\"\",
    \"ad_idea\": \"\\\"Full ad idea description\\\"\",
    \"campaign_type\": \"Brand or Service\",
    \"tags\": [
        \"tag1\",
        \"tag2\"
    ],
    \"visual_style\": \"Realistic 35mm Film\",
    \"length_seconds\": 60,
    \"aspect_ratio\": \"16:9\"
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "\"AI Filmmaking\"",
    "ad_idea": "\"Full ad idea description\"",
    "campaign_type": "Brand or Service",
    "tags": [
        "tag1",
        "tag2"
    ],
    "visual_style": "Realistic 35mm Film",
    "length_seconds": 60,
    "aspect_ratio": "16:9"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => '"AI Filmmaking"',
            'ad_idea' => '"Full ad idea description"',
            'campaign_type' => 'Brand or Service',
            'tags' => [
                'tag1',
                'tag2',
            ],
            'visual_style' => 'Realistic 35mm Film',
            'length_seconds' => 60,
            'aspect_ratio' => '16:9',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag'
payload = {
    "title": "\"AI Filmmaking\"",
    "ad_idea": "\"Full ad idea description\"",
    "campaign_type": "Brand or Service",
    "tags": [
        "tag1",
        "tag2"
    ],
    "visual_style": "Realistic 35mm Film",
    "length_seconds": 60,
    "aspect_ratio": "16:9"
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):


{"project": {"id": "01H...", "title": "Updated Title", "slug": "updated-title", ...}}

Example response (422, Validation failed):


{
    "error": "Validation failed"
}

Request      

PUT api/projects/{project_id}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Body Parameters

title   string  optional    

The new project title. Example: "AI Filmmaking"

ad_idea   string  optional    

The new ad idea description. Example: "Full ad idea description"

campaign_type   string  optional    

The campaign_type enum value. Example: Brand or Service

Must be one of:
  • Brand or Service
  • Personal Brand / Service / Client
  • Cinematic Short Film Story (No Product)
  • Scale Your Skool Community
tags   string[]  optional    

The tags for the project.

visual_style   string  optional    

The visual style enum value. Example: Realistic 35mm Film

Must be one of:
  • Realistic 35mm Film
  • Oil Painting
  • Stop Frame Animation
  • CinePlastic
  • 90s Comic Book Art
  • Origami Style
  • Storybook Style
length_seconds   integer  optional    

The video length in seconds (1-600). Example: 60

aspect_ratio   string  optional    

The aspect ratio enum value. Example: 16:9

Must be one of:
  • 9:16
  • 1:1
  • 16:9

Delete Project

requires authentication

Example request:
curl --request DELETE \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{
    "message": "Project deleted successfully"
}

Request      

DELETE api/projects/{project_id}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Get Project Data Schema

requires authentication

Retrieve the JSON schema for project data validation

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/data/schema" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/data/schema"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/data/schema';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/data/schema'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


the schema object

Example response (404, Schema not found):


{
    "error": "Schema file not found"
}

Example response (500, Invalid schema):


{
    "error": "Invalid JSON schema"
}

Request      

GET api/projects/data/schema

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

Get Project Data

requires authentication

Retrieve the project's JSON data

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/data" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/data"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/data';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/data'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


the project data object

Request      

GET api/projects/{project_id}/data

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Update Project Data

requires authentication

Example request:
curl --request PUT \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/data" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": \"[\\\"architecto\\\",\\\"architecto\\\"]\"
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/data"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "data": "[\"architecto\",\"architecto\"]"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/data';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'data' => '["architecto","architecto"]',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/data'
payload = {
    "data": "[\"architecto\",\"architecto\"]"
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request      

PUT api/projects/{project_id}/data

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Body Parameters

data   string     

Must be a valid JSON string. Example: ["architecto","architecto"]

Update Project Editor Data

requires authentication

Updates only the editor field within the project data, keeping all other data unchanged.

Example request:
curl --request PUT \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/editor" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"editor\": []
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/editor"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "editor": []
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/editor';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'editor' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/editor'
payload = {
    "editor": []
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request      

PUT api/projects/{project_id}/editor

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Body Parameters

editor   object     

Score

Get Score

requires authentication

Retrieve the score configuration from the project data

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/score

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Is Score Generating

requires authentication

Check if the score is currently being generated

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score/generating" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score/generating"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score/generating';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score/generating'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


true

Request      

GET api/projects/{project_id}/score/generating

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Create Score

requires authentication

Create and generate the score configuration

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"prompt\": null
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "prompt": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'prompt' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score'
payload = {
    "prompt": null
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/projects/{project_id}/score

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Body Parameters

prompt   string     

Score description prompt.

Update Score

requires authentication

Update the score configuration in the project data

Example request:
curl --request PUT \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers)
response.json()

Request      

PUT api/projects/{project_id}/score

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Body Parameters

prompt   string  optional    

Score description prompt.

Regenerate Score

requires authentication

Force regeneration of the score

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score/regenerate" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score/regenerate"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score/regenerate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score/regenerate'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/projects/{project_id}/score/regenerate

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Delete Score

requires authentication

Reset the score configuration to the default state

Example request:
curl --request DELETE \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/score'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{
    "message": "Score configuration deleted successfully"
}

Example response (422, Validation failed):


{
    "error": "Failed to delete score: Invalid data"
}

Request      

DELETE api/projects/{project_id}/score

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Response

Response Fields

message   string     

Success message

Elements

Get Elements

requires authentication

Retrieve all elements from the project data

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/elements

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Get Element

requires authentication

Retrieve a specific element by its ID

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/elements/{elementId}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

elementId   string     

Example: architecto

Is Element Generating

requires authentication

Check if the element image is currently being generated

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto/generating" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto/generating"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto/generating';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto/generating'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/elements/{elementId}/generating

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

elementId   string     

Example: architecto

Create Element

requires authentication

Add a new element to the project data based on schema structure

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": null,
    \"prompt\": null,
    \"type\": \"architecto\"
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": null,
    "prompt": null,
    "type": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => null,
            'prompt' => null,
            'type' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements'
payload = {
    "name": null,
    "prompt": null,
    "type": "architecto"
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/projects/{project_id}/elements

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Body Parameters

name   string     

Element name.

prompt   string     

Element description prompt.

type   string     

Example: architecto

Update Element

requires authentication

Update an existing element by its ID

Example request:
curl --request PUT \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"architecto\"
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "architecto"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto'
payload = {
    "type": "architecto"
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request      

PUT api/projects/{project_id}/elements/{elementId}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

elementId   string     

Example: architecto

Body Parameters

name   string  optional    

Element name.

prompt   string  optional    

Element description prompt.

type   string  optional    

Example: architecto

Regenerate Element Image

requires authentication

Force regeneration of the element image

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto/regenerate" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto/regenerate"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto/regenerate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto/regenerate'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/projects/{project_id}/elements/{elementId}/regenerate

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

elementId   string     

Example: architecto

Delete Element

requires authentication

Remove a element from the project data

Example request:
curl --request DELETE \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/elements/architecto'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/projects/{project_id}/elements/{elementId}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

elementId   string     

Example: architecto

Scenes

Get Scenes

requires authentication

Retrieve all scenes from the project data

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/scenes

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Get Scene

requires authentication

Retrieve a specific scene by its ID

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/scenes/{sceneId}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

Update Scene

requires authentication

Update an existing scene by its ID

Example request:
curl --request PUT \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"number\": 16,
    \"label\": \"HOOK\",
    \"visible_goal\": \"architecto\"
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "number": 16,
    "label": "HOOK",
    "visible_goal": "architecto"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'number' => 16,
            'label' => 'HOOK',
            'visible_goal' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto'
payload = {
    "number": 16,
    "label": "HOOK",
    "visible_goal": "architecto"
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request      

PUT api/projects/{project_id}/scenes/{sceneId}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

Body Parameters

number   integer  optional    

Scene number starting from 1, increasing sequentially Example: 16

label   string  optional    

Narrative function. Example: HOOK

Must be one of:
  • HOOK
  • FORESHADOW_VALUE_DISCOVERY
  • ALL_IS_LOST_SOLUTION_TRIGGER
  • CLIMAX_TWIST_PAYOFF
  • TRANSFORMATION_CTA
visible_goal   string  optional    

The visible goal of the scene Example: architecto

Visuals

Get Visuals

requires authentication

Retrieve all visuals for a specific scene

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/scenes/{sceneId}/visuals

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

Get Visual

requires authentication

Retrieve a specific visual by scene ID and visual ID

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Create Visual

requires authentication

Add a new visual to a scene with basic structure

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"number\": 16,
    \"duration_seconds\": 4326.41688,
    \"description\": \"Eius et animi quos velit et.\"
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "number": 16,
    "duration_seconds": 4326.41688,
    "description": "Eius et animi quos velit et."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'number' => 16,
            'duration_seconds' => 4326.41688,
            'description' => 'Eius et animi quos velit et.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals'
payload = {
    "number": 16,
    "duration_seconds": 4326.41688,
    "description": "Eius et animi quos velit et."
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/projects/{project_id}/scenes/{sceneId}/visuals

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

Body Parameters

number   integer     

Visual number inside this scene, starting from 1 Example: 16

duration_seconds   number     

Playback duration in seconds (supports fractional values) Example: 4326.41688

description   string     

Visual short description Example: Eius et animi quos velit et.

Update Visual

requires authentication

Update an existing visual by scene ID and visual ID

Example request:
curl --request PUT \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"number\": 16,
    \"duration_seconds\": 4326.41688,
    \"description\": \"Eius et animi quos velit et.\"
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "number": 16,
    "duration_seconds": 4326.41688,
    "description": "Eius et animi quos velit et."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'number' => 16,
            'duration_seconds' => 4326.41688,
            'description' => 'Eius et animi quos velit et.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto'
payload = {
    "number": 16,
    "duration_seconds": 4326.41688,
    "description": "Eius et animi quos velit et."
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request      

PUT api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Body Parameters

number   integer  optional    

Visual number inside this scene, starting from 1 Example: 16

duration_seconds   number  optional    

Playback duration in seconds (supports fractional values) Example: 4326.41688

description   string  optional    

Visual short description Example: Eius et animi quos velit et.

Delete Visual

requires authentication

Remove a visual from a scene

Example request:
curl --request DELETE \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Request      

DELETE api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Visual Voiceover

Is Visual Voiceover Generating

requires authentication

Check if the visual voiceover is currently being generated

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers/generating" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers/generating"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers/generating';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers/generating'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/voiceovers/generating

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Update Visual Voiceover

requires authentication

Update the voiceover configuration for a specific visual

Example request:
curl --request PUT \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"architecto\"
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "architecto"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'text' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers'
payload = {
    "text": "architecto"
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request      

PUT api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/voiceovers

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Body Parameters

text   string  optional    

The voiceover text Example: architecto

Regenerate Visual Voiceover

requires authentication

Force regeneration of the voiceover for a specific visual

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers/regenerate" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers/regenerate"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers/regenerate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/voiceovers/regenerate'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/voiceovers/regenerate

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Bulk Regenerate Visual Voiceovers

requires authentication

Force regeneration of voiceovers for all visuals with voiceover text in bulk

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/voiceovers/regenerate-all" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/voiceovers/regenerate-all"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/voiceovers/regenerate-all';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/voiceovers/regenerate-all'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/projects/{project_id}/voiceovers/regenerate-all

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Visual Image

Is Visual Image Generating

requires authentication

Check if the visual image is currently being generated

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images/generating" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images/generating"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images/generating';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images/generating'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/images/generating

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Update Visual Image

requires authentication

Update the image configuration for a specific visual

Example request:
curl --request PUT \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"prompt\": \"architecto\",
    \"visible_elements\": [
        \"architecto\"
    ]
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "prompt": "architecto",
    "visible_elements": [
        "architecto"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'prompt' => 'architecto',
            'visible_elements' => [
                'architecto',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images'
payload = {
    "prompt": "architecto",
    "visible_elements": [
        "architecto"
    ]
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request      

PUT api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/images

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Body Parameters

prompt   string  optional    

The full rendering instruction for text to image Example: architecto

visible_elements   string[]  optional    

List of element IDs visible in this image

Regenerate Visual Image

requires authentication

Force regeneration of the image for a specific visual

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images/regenerate" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images/regenerate"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images/regenerate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/images/regenerate'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/images/regenerate

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Visual Video

Is Visual Video Generating

requires authentication

Check if the visual video is currently being generated

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos/generating" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos/generating"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos/generating';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos/generating'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/videos/generating

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Update Visual Video

requires authentication

Update the video configuration for a specific visual

Example request:
curl --request PUT \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"prompt\": \"architecto\",
    \"generation_mode\": \"start_only\"
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "prompt": "architecto",
    "generation_mode": "start_only"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'prompt' => 'architecto',
            'generation_mode' => 'start_only',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos'
payload = {
    "prompt": "architecto",
    "generation_mode": "start_only"
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request      

PUT api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/videos

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Body Parameters

prompt   string  optional    

The prompt for the image to video generation Example: architecto

generation_mode   string  optional    

nullable The video generation mode to apply. Example: start_only

Must be one of:
  • start_only
  • start_to_end
  • start_equals_end

Regenerate Visual Video

requires authentication

Force regeneration of the video for a specific visual

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos/regenerate" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos/regenerate"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos/regenerate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/videos/regenerate'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/videos/regenerate

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Visual Sound

Is Visual Sound Generating

requires authentication

Check if the visual sound is currently being generated

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds/generating" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds/generating"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds/generating';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds/generating'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/sounds/generating

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Update Visual Sound

requires authentication

Update the sound configuration for a specific visual

Example request:
curl --request PUT \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"prompt\": \"architecto\"
}"

const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "prompt": "architecto"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'prompt' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds'
payload = {
    "prompt": "architecto"
}
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Request      

PUT api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/sounds

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Body Parameters

prompt   string  optional    

The prompt for sound generation Example: architecto

Regenerate Visual Sound

requires authentication

Force regeneration of the sound for a specific visual

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds/regenerate" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds/regenerate"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds/regenerate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/scenes/architecto/visuals/architecto/sounds/regenerate'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/projects/{project_id}/scenes/{sceneId}/visuals/{visualId}/sounds/regenerate

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

sceneId   string     

Example: architecto

visualId   string     

Example: architecto

Video

Get Final Video

requires authentication

Retrieve the video configuration from the project data

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


{
    "assetId": "final-video",
    "processing": false,
    "processing_error": null,
    "generated_hash": null
}

Request      

GET api/projects/{project_id}/video

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Response

Response Fields

assetId   string|null     

ID of the editor asset backing the rendered video. Resolve URLs via assets[assetId].remoteUrl.

processing   boolean     

Whether the full stitched video is generating

processing_error   string|null     

Error message if rendering failed

generated_hash   string|null     

Hash of the visual prompts used to produce the final video

Is Video Generating

requires authentication

Check if the final video is currently being generated

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video/generating" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video/generating"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video/generating';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video/generating'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):


true

Request      

GET api/projects/{project_id}/video/generating

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Generate Final Video

requires authentication

Generate the final video using remotion lambda renderer

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video/regenerate" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video/regenerate"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video/regenerate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video/regenerate'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Example response (200):


{
    "assetId": "final-video",
    "processing": true,
    "processing_error": null
}

Example response (422, Already processing):


{
    "error": "Video is already being generated"
}

Request      

POST api/projects/{project_id}/video/regenerate

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Delete Final Video

requires authentication

Reset the video configuration to the default state

Example request:
curl --request DELETE \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/video'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('DELETE', url, headers=headers)
response.json()

Example response (200):


{
    "message": "Video configuration deleted successfully"
}

Example response (422, Validation failed):


{
    "error": "Failed to delete video: Invalid data"
}

Request      

DELETE api/projects/{project_id}/video

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Response

Response Fields

message   string     

Success message

Endpoints

Stream a zip of the project's current assets (elements, score, scenes).

requires authentication

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/download

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Start async archive build.

requires authentication

Example request:
curl --request POST \
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/projects/{project_id}/download

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

Check archive build status.

requires authentication

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download/architecto" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download/architecto"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download/architecto';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/download/architecto'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/download/{requestId}

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag

requestId   string     

Example: architecto

Download a single asset through same-origin to bypass CORS.

requires authentication

Example request:
curl --request GET \
    --get "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/asset-download" \
    --header "Authorization: Bearer 6g43cv8PD1aE5beadkZfhV6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/asset-download"
);

const headers = {
    "Authorization": "Bearer 6g43cv8PD1aE5beadkZfhV6",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/asset-download';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer 6g43cv8PD1aE5beadkZfhV6',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://dev.adblast.ai/api/projects/01k48af794v8vh2fx2tssj0sag/asset-download'
headers = {
  'Authorization': 'Bearer 6g43cv8PD1aE5beadkZfhV6',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}

Request      

GET api/projects/{project_id}/asset-download

Headers

Authorization        

Example: Bearer 6g43cv8PD1aE5beadkZfhV6

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

project_id   string     

The ID of the project. Example: 01k48af794v8vh2fx2tssj0sag