v106

OpenAPI 3.1.0raw.githubusercontent.com2026-08-02160524464.6 KB

Runs

Start Run

Requests start for a submitted run. User-created runs become runnable; parent-generated child runs may become pending until approved. Provide resume=true to resume an interrupted run from checkpoint. Returns 409 if the run is not startable.

post/api/v1/runs/{id}/start

Path parameters

idstring required

Unique run identifier (ULID).

Request body

resumeboolean

Resume from checkpoint instead of starting from submitted state.

Response

Run started

idstring required

parent_idstring nullable

Current orchestration parent run ID, if linked.

children_countinteger required

Number of runs currently linked to this run as their orchestration parent.

titlestring required

goalstring required

labelsobject required

source_directorystring nullable required

size'XS' | 'S' | 'M' | 'L' | 'XL' required

Run size bucket derived from current best-effort billed usage.

superseded_bystring nullable required

Run ID that superseded this run via rewind, if any.

retried_fromstring nullable required

Source run ID when this run was created by manual retry.

Example response

{
  "repository": {
    "name": "fabro-sh/fabro",
    "origin_url": "https://github.com/fabro-sh/fabro.git"
  },
  "lifecycle": {
    "error": {
      "message": "Stage 'apply-changes' exceeded maximum retries."
    }
  },
  "timing": {
    "wall_time_ms": 420000,
    "inference_time_ms": 120000,
    "tool_time_ms": 60000,
    "active_time_ms": 180000
  },
  "diff": {
    "files_changed": 42,
    "additions": 567,
    "deletions": 234
  },
  "pull_request": {
    "owner": "fabro-sh",
    "repo": "fabro",
    "number": 123,
    "html_url": "https://github.com/fabro-sh/fabro/pull/123"
  },
  "current_question": {
    "text": "Accept or push for another round?"
  }
}