Skip to main content
POST
/
api
/
v1
/
canvases
/
{canvasId}
/
bulk-run
Start a bulk run
curl --request POST \
  --url https://api.melius.com/api/v1/canvases/{canvasId}/bulk-run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-team-id: <api-key>' \
  --data '
{
  "nodeIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "imageUrls": [
    "<string>"
  ],
  "numVariations": 5,
  "matchAudioToVideoDurationNodeIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
import requests

url = "https://api.melius.com/api/v1/canvases/{canvasId}/bulk-run"

payload = {
    "nodeIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "imageUrls": ["<string>"],
    "numVariations": 5,
    "matchAudioToVideoDurationNodeIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "Authorization": "Bearer <token>",
    "x-team-id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'x-team-id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    nodeIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    imageUrls: ['<string>'],
    numVariations: 5,
    matchAudioToVideoDurationNodeIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.melius.com/api/v1/canvases/{canvasId}/bulk-run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.melius.com/api/v1/canvases/{canvasId}/bulk-run",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'nodeIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'imageUrls' => [
        '<string>'
    ],
    'numVariations' => 5,
    'matchAudioToVideoDurationNodeIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-team-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.melius.com/api/v1/canvases/{canvasId}/bulk-run"

	payload := strings.NewReader("{\n  \"nodeIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"imageUrls\": [\n    \"<string>\"\n  ],\n  \"numVariations\": 5,\n  \"matchAudioToVideoDurationNodeIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-team-id", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://api.melius.com/api/v1/canvases/{canvasId}/bulk-run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-team-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"nodeIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"imageUrls\": [\n    \"<string>\"\n  ],\n  \"numVariations\": 5,\n  \"matchAudioToVideoDurationNodeIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "canvasId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "totalNodes": 123,
  "completedNodes": 123,
  "failedNodes": 123,
  "skippedNodes": 123,
  "nodeEntries": [
    {
      "nodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "nodeRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "errorMessage": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}
{
  "approvalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
{
  "message": "<string>"
}
{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}
{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}
{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>",
  "retryAfterSeconds": 123
}

Authorizations

Authorization
string
header
required

A Melius API key (mel_...), sent as Authorization: Bearer <key>.

x-team-id
string
header
required

The team (workspace) to act on. Defaults to the key's team when omitted.

Path Parameters

canvasId
string<uuid>
required

Body

application/json

Body

nodeIds
string<uuid>[]
required
Required array length: 1 - 500 elements
imageUrls
string<uri>[]
numVariations
integer
Required range: 1 <= x <= 10
matchAudioToVideoDurationNodeIds
string<uuid>[]
Maximum array length: 500

Response

201

id
string<uuid>
required
canvasId
string<uuid>
required
status
enum<string>
required
Available options:
pending,
running,
finished,
failed
totalNodes
integer
required
completedNodes
integer
required
failedNodes
integer
required
skippedNodes
integer
required
nodeEntries
object[]
required
createdAt
string<date-time>
required
Last modified on July 9, 2026