Dataset Workbench

Start a run (render + verify)

Start one augmentation run job over the saved sample + plan: mine pairs from the selected episodes, compose, render (real GPU spend), and gate every candidate. Returns the job id, poll GET /api/aug/jobs/{job_id}.

Playground precise-splice path: pass pairs (records returned VERBATIM by …/episodes//partners or …/proposals) and the explicit pairs REPLACE the sample/plan requirement, the chosen pairs ARE the selection. Only the first 8 records are used; each is re-validated (integer A/B in range, every numeric field present and in bounds), so a forged record is rejected 400.

Refused while health is recomputing after a target switch (409, so a run always reflects the settled target); when the plan’s transforms don’t run in the workbench yet (object swap / environment restyle , 400 until New trajectories is added); and when new-trajectory is not READY for this dataset per the …/transforms catalog, e.g. the target class is not certified (400 with the specific missing step). Fail-closed: if readiness cannot be evaluated the run does not start (503).

POST

api

workbench

campaigns

{campaign_id}

runs

Start a run (render + verify)

curl --request POST \
  --url https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pairs": [
    {
      "A": 123,
      "B": 123,
      "divergence": 123,
      "end_divergence": 123,
      "n_blend": 123,
      "tail_len": 123,
      "grasp_frame_A": 123,
      "grasp_frame_B": 123
    }
  ]
}
'

import requests

url = "https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs"

payload = { "pairs": [
        {
            "A": 123,
            "B": 123,
            "divergence": 123,
            "end_divergence": 123,
            "n_blend": 123,
            "tail_len": 123,
            "grasp_frame_A": 123,
            "grasp_frame_B": 123
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pairs: [
      {
        A: 123,
        B: 123,
        divergence: 123,
        end_divergence: 123,
        n_blend: 123,
        tail_len: 123,
        grasp_frame_A: 123,
        grasp_frame_B: 123
      }
    ]
  })
};

fetch('https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs', 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://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs",
  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([
    'pairs' => [
        [
                'A' => 123,
                'B' => 123,
                'divergence' => 123,
                'end_divergence' => 123,
                'n_blend' => 123,
                'tail_len' => 123,
                'grasp_frame_A' => 123,
                'grasp_frame_B' => 123
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs"

	payload := strings.NewReader("{\n  \"pairs\": [\n    {\n      \"A\": 123,\n      \"B\": 123,\n      \"divergence\": 123,\n      \"end_divergence\": 123,\n      \"n_blend\": 123,\n      \"tail_len\": 123,\n      \"grasp_frame_A\": 123,\n      \"grasp_frame_B\": 123\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pairs\": [\n    {\n      \"A\": 123,\n      \"B\": 123,\n      \"divergence\": 123,\n      \"end_divergence\": 123,\n      \"n_blend\": 123,\n      \"tail_len\": 123,\n      \"grasp_frame_A\": 123,\n      \"grasp_frame_B\": 123\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pairs\": [\n    {\n      \"A\": 123,\n      \"B\": 123,\n      \"divergence\": 123,\n      \"end_divergence\": 123,\n      \"n_blend\": 123,\n      \"tail_len\": 123,\n      \"grasp_frame_A\": 123,\n      \"grasp_frame_B\": 123\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "job_id": "aug_9f8e7d6c5b4a"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

Authorizations

Authorization

string

header

required

Either a Supabase user access token (from a password login, or the passwordless magic-link flow) or a long-lived forge_sk_… API key. Both are sent as Authorization: Bearer <value> and resolve to the same owner, so every endpoint accepts either. Session tokens expire in ~1h; API keys do not expire and are the credential for MCP clients, CI, and partner integrations.

Path Parameters

campaign_id

string

required

Body

application/json

pairs

object[]

Explicit pair records (send /partners or /proposals records verbatim). Replaces the sample+plan path; only the first 8 are used.

Show child attributes

Response

Run started.

job_id

string

Example:

"aug_9f8e7d6c5b4a"

Start a run (render + verify)

curl --request POST \
  --url https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pairs": [
    {
      "A": 123,
      "B": 123,
      "divergence": 123,
      "end_divergence": 123,
      "n_blend": 123,
      "tail_len": 123,
      "grasp_frame_A": 123,
      "grasp_frame_B": 123
    }
  ]
}
'

import requests

url = "https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs"

payload = { "pairs": [
        {
            "A": 123,
            "B": 123,
            "divergence": 123,
            "end_divergence": 123,
            "n_blend": 123,
            "tail_len": 123,
            "grasp_frame_A": 123,
            "grasp_frame_B": 123
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pairs: [
      {
        A: 123,
        B: 123,
        divergence: 123,
        end_divergence: 123,
        n_blend: 123,
        tail_len: 123,
        grasp_frame_A: 123,
        grasp_frame_B: 123
      }
    ]
  })
};

fetch('https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs', 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://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs",
  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([
    'pairs' => [
        [
                'A' => 123,
                'B' => 123,
                'divergence' => 123,
                'end_divergence' => 123,
                'n_blend' => 123,
                'tail_len' => 123,
                'grasp_frame_A' => 123,
                'grasp_frame_B' => 123
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs"

	payload := strings.NewReader("{\n  \"pairs\": [\n    {\n      \"A\": 123,\n      \"B\": 123,\n      \"divergence\": 123,\n      \"end_divergence\": 123,\n      \"n_blend\": 123,\n      \"tail_len\": 123,\n      \"grasp_frame_A\": 123,\n      \"grasp_frame_B\": 123\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pairs\": [\n    {\n      \"A\": 123,\n      \"B\": 123,\n      \"divergence\": 123,\n      \"end_divergence\": 123,\n      \"n_blend\": 123,\n      \"tail_len\": 123,\n      \"grasp_frame_A\": 123,\n      \"grasp_frame_B\": 123\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}/runs")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pairs\": [\n    {\n      \"A\": 123,\n      \"B\": 123,\n      \"divergence\": 123,\n      \"end_divergence\": 123,\n      \"n_blend\": 123,\n      \"tail_len\": 123,\n      \"grasp_frame_A\": 123,\n      \"grasp_frame_B\": 123\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "job_id": "aug_9f8e7d6c5b4a"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

Play API

Forge API

Train API

Start a run (render + verify)

Authorizations

Path Parameters

Body

Response