> ## 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.

# Mine pair proposals

> Run the miner over the campaign's dataset with your criteria overriding the engine defaults, seeded with the learned per-head yield from prior runs. Returns ranked head/tail pair records (and the yield seed used).




## OpenAPI

````yaml /forge-api-v1.yaml post /api/workbench/campaigns/{campaign_id}/proposals
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/{campaign_id}/proposals:
    servers:
      - url: https://forge.alakazam.gg
        description: Forge (Dataset Workbench)
    post:
      tags:
        - Dataset Workbench
      summary: Mine pair proposals
      description: >
        Run the miner over the campaign's dataset with your criteria overriding
        the engine defaults, seeded with the learned per-head yield from prior
        runs. Returns ranked head/tail pair records (and the yield seed used).
      parameters:
        - name: campaign_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                div_band:
                  type: array
                  items:
                    type: number
                  minItems: 2
                  maxItems: 2
                  nullable: true
                  description: >-
                    [lo, hi] divergence band (degrees) overriding the engine
                    default.
                'n':
                  type: integer
                  default: 24
                  description: How many proposals to mine.
                max_per_head:
                  type: integer
                  nullable: true
                  description: Cap on pairs sharing one head episode.
                max_per_tail:
                  type: integer
                  nullable: true
                  description: Cap on pairs sharing one tail episode.
      responses:
        '200':
          description: The mined proposals
          content:
            application/json:
              schema:
                type: object
                properties:
                  proposals:
                    type: array
                    items:
                      $ref: '#/components/schemas/WorkbenchPairRecord'
                  head_stats:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        accepted:
                          type: integer
                        rejected:
                          type: integer
                    description: The cumulative per-head yield the mining was seeded with.
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Campaign not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Mining failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - UserAuth: []
components:
  schemas:
    WorkbenchPairRecord:
      type: object
      description: >
        One mined head/tail splice pair for the new-trajectory transform:
        episode A's approach spliced onto episode B's placement. Returned by the
        proposals and partners endpoints, and accepted back VERBATIM by `POST
        …/runs` (`pairs`), which validates that every field is present and in
        bounds, a forged or hand-edited record is rejected `400`.
      required:
        - A
        - B
        - divergence
        - end_divergence
        - n_blend
        - tail_len
        - grasp_frame_A
        - grasp_frame_B
      properties:
        A:
          type: integer
          description: Head (approach) source episode index.
        B:
          type: integer
          description: Tail (placement) source episode index.
        divergence:
          type: number
          description: Grasp-point divergence between the two trajectories (degrees).
        end_divergence:
          type: number
          description: End-point divergence (degrees).
        n_blend:
          type: integer
          description: Blend window length (frames).
        tail_len:
          type: integer
          description: Tail segment length (frames).
        grasp_frame_A:
          type: integer
          description: Detected grasp frame in episode A.
        grasp_frame_B:
          type: integer
          description: Detected grasp frame in episode B.
    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.

````