Replace the active CI run for a GitHub pull request and start a new one

Cancels queued or running Replay work for the same repository and pull request, then creates a version-backed exploration linked to that PR. GitHub Actions remains responsible for the visible check result.

post/api/v1/projects/{project_id}/ci-runs

Request

  • Base URL: https://qa.replay.io
  • URL: https://qa.replay.io/api/v1/projects/{project_id}/ci-runs
  • Auth: HTTP bearer

Path parameters

project_idstring required

Request body

promptstring required

What the CI exploration should exercise.

repositorystring required

GitHub repository in owner/name form.

pr_numberinteger required

GitHub pull request number.

head_shastring required

The pull request head commit SHA.

branchstring required

The pull request head branch.

workflow_run_idstring required

The GitHub Actions run id that owns this revision.

change_descriptionstring

Optional human-readable PR description.

Response

Started CI PR run and returned its exploration/version identity.

Changes

No recorded changes to this operation across all 1 revision of this API.