Sign in
Runs

Create Run Pull Request

Durably requests creation of a pull request for a completed run. The server generates the pull request content and creates the GitHub pull request after this request returns. Poll the URL in the Location response header until the creation succeeds or fails.

If a creation is already pending for the run, the response returns that creation unchanged; any different model or force values in the new request are ignored.

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

Path parameters

idstring required

Unique run identifier (ULID).

Request body

forceboolean required

Create the pull request even if the run did not finish with succeeded or partially_succeeded.

modelstring nullable

Optional model override for generating the pull request description.

Example request

{
  "model": "claude-sonnet-4-6"
}

Response

Pull request creation was durably accepted

idstring required

Stable identifier for one explicit pull request creation request.

status'pending' | 'succeeded' | 'failed' required

Durable state of a pull request creation request.

modelstring required

Resolved model identifier used to generate the pull request content.

forceboolean required

Whether creation was allowed for a run without a successful conclusion.

requested_atstring date-time required
updated_atstring date-time required
errorstring nullable

Example response

{
  "id": "01KYYK70WTZT2E551P3H5P0059",
  "pull_request": {
    "owner": "fabro-sh",
    "repo": "fabro",
    "number": 123,
    "html_url": "https://github.com/fabro-sh/fabro/pull/123"
  }
}

Changes

Changed in 2 of the 172 revisions of this API.16

  • efc644ab09d44See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

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

  • 359433692f0612See the full diff
    • ▲

      removed the success response with the status

      response-success-status-removed

    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    • ○

      added the success response with the status

      response-success-status-added