Skip to main content
POST
Request a change request review

Authorizations

Authorization
string
header
required

Your Reason API key from Settings > API. New keys use reason_; legacy ara_ keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, knowledge:read, memory:read, memory:write, skills:read, skills:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, network:read, network:write, automations:read, automations:write, agent_auth:read. network:read and network:write are opt-in, excluded from default keys. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

Body

application/json
repository
string

GitHub repository path in owner/name form, such as acme/web; accepted for compatibility while automated reviews are disabled.

pr_number
integer

The pull request number to review.

pr_url
string

GitHub pull request URL. Alternative to repository + pr_number.

provider
enum<string>

Host of the pull request, for clients that name it; it does not change the result while reviews are off.

Available options:
github
instructions
string

Areas or concerns the review should focus on, such as authentication changes; accepted but not acted on while automated reviews are disabled.

Response

Legacy success response retained for client compatibility. The code-disabled service does not emit this response.

Not sent while automated reviews are disabled; every well-formed request returns 409 instead.

pr_review_id
string

Id of the review run.

status
string

Status of the new review run.