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?"
  }
}

Changes

Changed in 13 of the 134 revisions of this API.10421

  • ef906071a8e412See the full diff
    • added the new publish_failed enum value to the lifecycle/status/oneOf[RunStatusFailed]/reason response property for the response status 200

      response-property-enum-value-added

    • the response property timing/oneOf[RunTiming]/inference_time_ms became required for the status 200

      response-property-became-required

    • the response property timing/oneOf[RunTiming]/tool_time_ms became required for the status 200

      response-property-became-required

  • 7fe7b675579921See the full diff
    • the response property timing/oneOf[RunTiming]/inference_time_ms became optional for the status 200

      response-property-became-optional

    • the response property timing/oneOf[RunTiming]/tool_time_ms became optional for the status 200

      response-property-became-optional

    • removed the publish_failed enum value from the lifecycle/status/oneOf[RunStatusFailed]/reason response property for the response status 200

      response-property-enum-value-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4f9aedeb721112See the full diff
    • added the new publish_failed enum value to the lifecycle/status/oneOf[RunStatusFailed]/reason response property for the response status 200

      response-property-enum-value-added

    • the response property timing/oneOf[RunTiming]/inference_time_ms became required for the status 200

      response-property-became-required

    • the response property timing/oneOf[RunTiming]/tool_time_ms became required for the status 200

      response-property-became-required

    • the response property timing/oneOf[RunTiming]/inference_time_ms became optional for the status 200

      response-property-became-optional

    • the response property timing/oneOf[RunTiming]/tool_time_ms became optional for the status 200

      response-property-became-optional

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property timing/oneOf[RunTiming]/inference_time_ms became required for the status 200

      response-property-became-required

    • the response property timing/oneOf[RunTiming]/tool_time_ms became required for the status 200

      response-property-became-required

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the publish_failed enum value from the lifecycle/status/oneOf[RunStatusFailed]/reason response property for the response status 200

      response-property-enum-value-removed

    • added the new publish_failed enum value to the lifecycle/status/oneOf[RunStatusFailed]/reason response property for the response status 200

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • de85d055604012See the full diff
    • added PrincipalUser PrincipalWorker PrincipalWebhook PrincipalSlack PrincipalAgent PrincipalSystem to the created_by response property oneOf list for the response status 200

      response-property-one-of-added

    • added discriminator to created_by response property for the response status 200

      response-property-discriminator-added

    • removed Principal subschema #2 from the created_by response property oneOf list for the response status 200

      response-property-one-of-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1fa851815cf244See the full diff
    • removed the required property sandbox/oneOf[RunSandbox]/image from the response with the 200 status

      response-required-property-removed

    • removed the required property sandbox/oneOf[RunSandbox]/provider from the response with the 200 status

      response-required-property-removed

    • removed the required property sandbox/oneOf[RunSandbox]/runtime from the response with the 200 status

      response-required-property-removed

    • removed the required property sandbox/oneOf[RunSandbox]/snapshot from the response with the 200 status

      response-required-property-removed

    • added the optional property sandbox/oneOf[RunSandbox]/failure to the response with the 200 status

      response-optional-property-added

    • added the optional property sandbox/oneOf[RunSandbox]/instance to the response with the 200 status

      response-optional-property-added

    • added the required property sandbox/oneOf[RunSandbox]/kind to the response with the 200 status

      response-required-property-added

    • added the required property sandbox/oneOf[RunSandbox]/plan to the response with the 200 status

      response-required-property-added

    • added the optional property automation/oneOf[AutomationRef]/trigger_id to the response with the 200 status

      response-optional-property-added