> ## Documentation Index
> Fetch the complete documentation index at: https://docs.alakazam.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# List your campaigns



## OpenAPI

````yaml /forge-api-v1.yaml get /api/workbench/campaigns
openapi: 3.0.3
info:
  title: Alakazam Forge API
  version: '1.0'
  description: |
    The Forge Dataset Workbench API: upload or import robotics datasets,
    audit them, propose and run augmentation campaigns, review, and deliver.
    Served by the Forge workbench service at forge.alakazam.gg (not
    api.alakazam.gg).
servers:
  - url: https://forge.alakazam.gg
    description: Forge (Dataset Workbench)
security: []
tags:
  - name: Dataset Workbench
    description: |
      **Served at `https://forge.alakazam.gg`** (not the main API host). The
      Forge Dataset Workbench is the client surface of the robotics
      data-augmentation service: bring a LeRobot robot dataset, a public
      Hugging Face repo, a resumable chunked upload, or a one-click curated
      sample, and walk one owner-scoped **campaign** through the spine
      Source & Health → Sample → Transform → Run + Verify → Deliver, leaving
      with a verified augmented dataset. Every endpoint requires a **Supabase
      user access token** (`Authorization: Bearer …`, the `UserAuth` scheme);
      a missing or invalid token returns `401`, and another user's campaigns,
      runs, and uploads read as `404`. Errors use the platform envelope
      `{"detail": "…"}`. Nothing bills until **Deliver**, which charges 1
      credit per never-before-billed kept episode from your credits wallet.
  - name: Playground batches
    description: |
      The Forge playground's "describe a change" flow is not a REST surface on
      this host: a described change is submitted as a **scenario batch**
      through the platform (the Supabase RPC `create_scenario_batch`) and its
      progress/results stream back over Supabase realtime on the
      `scenario_batches` table. For the equivalent public REST surface, see
      **Scenario Studio** (`/v1/scenario-batches`).
paths:
  /api/workbench/campaigns:
    servers:
      - url: https://forge.alakazam.gg
        description: Forge (Dataset Workbench)
    get:
      tags:
        - Dataset Workbench
      summary: List your campaigns
      responses:
        '200':
          description: Your campaigns, newest first.
          content:
            application/json:
              schema:
                type: object
                properties:
                  campaigns:
                    type: array
                    items:
                      $ref: '#/components/schemas/WorkbenchCampaignSummary'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - UserAuth: []
components:
  schemas:
    WorkbenchCampaignSummary:
      type: object
      description: >-
        A campaign row in the list projection (GET /api/workbench/campaigns).
        Heavy fields (health report, sample, plan, reviews, delivery) are
        omitted; fetch the campaign for the full object.
      properties:
        campaign_id:
          type: string
          example: camp_1f2e3d4c5b6a
        name:
          type: string
        repo_id:
          type: string
        engine:
          type: string
        stage:
          type: string
          enum:
            - source
            - sample
            - transform
            - run
            - deliver
        dataset_source:
          type: string
          nullable: true
          description: >-
            `sample`, `upload`, or `remote_uri` (imported from
            S3/GCS/Azure/https via source_uri); absent for a plain Hugging Face
            repo campaign.
        health_status:
          type: string
          enum:
            - idle
            - computing
            - ready
            - failed
        run_ids:
          type: array
          items:
            type: string
        cost:
          type: object
          description: Render spend across the campaign's runs so far.
          properties:
            renders:
              type: integer
              description: Episodes rendered across all runs.
            est_usd:
              type: number
              description: Estimated render cost (USD).
        created_utc:
          type: string
          format: date-time
        updated_utc:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message.
        errors:
          type: array
          items:
            type: string
          description: Field-level validation errors (e.g. on 422 from POST /v1/worlds).
        schemaVersion:
          type: string
      required:
        - detail
  securitySchemes:
    UserAuth:
      type: http
      scheme: bearer
      description: >
        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.

````