Skip to main content
POST
Upload the current branch, publish a ready PR and verify CI follow

Body

application/json
base
string

Required existing target branch

bodyFile
string

UTF-8 PR description, relative to caller cwd; required for a new PR

dryRun
boolean

Preview only; also the default without --execute (exit 3)

execute
boolean

Publish externally and reconcile CI follow

expectSha
string

Require this full local commit SHA (default: capture HEAD)

replySession
string

Required only for an operator terminal without a session

repo
string

Required github.com destination; must match origin

title
string

Required for a new PR; existing PR text is preserved

Response

Success — body conforms to the @Returns schema.

attemptId
string
required
base
string
required
Required string length: 1 - 255
Pattern: ^[^\s\x00-\x1f~^:?*[\\]+$
checks
object
required
follow
object
required
head
string
required
Required string length: 1 - 255
Pattern: ^[^\s\x00-\x1f~^:?*[\\]+$
localSha
string
required
Pattern: ^[a-f0-9]{40}$
pr
object
required
publicationId
string
required
remoteSha
string
required
Pattern: ^[a-f0-9]{40}$
repo
string
required
Maximum string length: 200
Pattern: ^[A-Za-z0-9_.-]+\/[A-Za-z0-9_.-]+$
treeSha
string
required
Pattern: ^[a-f0-9]{40}$