Get a campaign

GET

api

workbench

campaigns

{campaign_id}

Get a campaign

curl --request GET \
  --url https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "campaign_id": "camp_1f2e3d4c5b6a",
  "name": "<string>",
  "repo_id": "<string>",
  "engine": "<string>",
  "stage": "source",
  "episodes": 123,
  "health": {},
  "health_status": "idle",
  "sample": {
    "selected": [
      123
    ],
    "count": 123
  },
  "plan": {
    "transformations": [
      {}
    ],
    "saved_utc": "2023-11-07T05:31:56Z"
  },
  "run_ids": [
    "<string>"
  ],
  "reviews": {},
  "delivery": {},
  "dataset_source": "<string>",
  "provenance": {},
  "target_class": "<string>",
  "created_utc": "2023-11-07T05:31:56Z",
  "updated_utc": "2023-11-07T05:31:56Z",
  "cost": {
    "renders": 123,
    "est_usd": 123
  },
  "head_stats": {}
}

{
  "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

Example:

"camp_1f2e3d4c5b6a"

Response

The campaign

A Dataset Workbench campaign (owner view): one walk of the augmentation spine over one source dataset. stage is the FURTHEST stage reached and never rolls back. Internal bookkeeping (owner, dataset/cache locations) is never surfaced. The set of already-billed episodes is tracked server-side but not exposed here, the deliver response reports how many episodes each delivery billed.

campaign_id

string

Example:

"camp_1f2e3d4c5b6a"

name

string

Display name, the repo's last path segment, the sample's label, or the upload's campaign_name.

repo_id

string

The source dataset: a Hugging Face repo id, or the upload's name for uploaded datasets.

engine

string

The augmentation engine (embodiment + pipeline) this campaign runs on.

stage

enum<string>

Furthest stage reached on the spine (monotonic).

Available options:

source,

sample,

transform,

run,

deliver

episodes

integer

Episode count of the SOURCE dataset.

health

object | null

The dataset health report once computed (null before): episode count, detected classes ({class: count}), the active target_class + class_column, arm_split, release stats, the eligible_pool, exclusions, and a motion-envelope p99_summary.

health_status

enum<string>

Health lifecycle. failed carries no report; re-POST …/health to retry.

Available options:

idle,

computing,

ready,

failed

sample

object | null

The saved sample (null until POST …/sample): the selected SOURCE episodes the transforms operate on.

Show child attributes

plan

object | null

The saved transformation plan (null until POST …/plan).

Show child attributes

run_ids

string[]

Run job ids, oldest first. Poll each at GET /api/aug/jobs/{job_id}.

reviews

object

Per-episode human verdicts, keyed by episode name: { verdict: confirm|overrule, by, at, note? }. Unreviewed episodes trust the machine gate verdict.

Show child attributes

delivery

object | null

Delivery state (null until POST …/deliver): status walks exporting → exported (→ publishing → published when a target_repo was given) or failed (with error), plus export_dir, count, the exported episodes, per-families counts, a format_note, and timestamps.

dataset_source

string | null

sample, upload, or remote_uri (imported from S3/GCS/Azure/https via source_uri); absent for a plain Hugging Face repo campaign.

provenance

object | null

Where the dataset came from, e.g. { source: sample, sample_id, opened_utc } or { source: upload, upload_id, manifest_sha, files, layout_notes, ingested_utc }.

target_class

string | null

Per-campaign target-class override chosen via POST …/target (absent = the engine default).

created_utc

string<date-time>

updated_utc

string<date-time>

cost

object

Computed render spend across the campaign's runs.

Show child attributes

head_stats

object

Cumulative per-head accept/reject yield across the campaign's prior runs ({head episode: {accepted, rejected}}), the learned-yield seed a top-up run carries forward.

Show child attributes

Get a campaign

curl --request GET \
  --url https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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://forge.alakazam.gg/api/workbench/campaigns/{campaign_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "campaign_id": "camp_1f2e3d4c5b6a",
  "name": "<string>",
  "repo_id": "<string>",
  "engine": "<string>",
  "stage": "source",
  "episodes": 123,
  "health": {},
  "health_status": "idle",
  "sample": {
    "selected": [
      123
    ],
    "count": 123
  },
  "plan": {
    "transformations": [
      {}
    ],
    "saved_utc": "2023-11-07T05:31:56Z"
  },
  "run_ids": [
    "<string>"
  ],
  "reviews": {},
  "delivery": {},
  "dataset_source": "<string>",
  "provenance": {},
  "target_class": "<string>",
  "created_utc": "2023-11-07T05:31:56Z",
  "updated_utc": "2023-11-07T05:31:56Z",
  "cost": {
    "renders": 123,
    "est_usd": 123
  },
  "head_stats": {}
}

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

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

Play API

Forge API

Train API

Authorizations

Path Parameters

Response