reviews

Trigger a code review of a worker's PR

Changed on
post/api/v1/sessions/{sessionId}/reviews/trigger

Request

  • Base URL
    http://127.0.0.1:3001
  • URL
    http://127.0.0.1:3001/api/v1/sessions/{sessionId}/reviews/trigger
  • Auth
    none declared

Path parameters

sessionIdstring required

Session identifier, e.g. project-1.

Request body

enableAutoInjectboolean

Turn on the worker session's review auto-inject once a pass has started, so the reviewer's PR review comments reach the worker.

harness'claude-code' | 'codex' | 'copilot' | 'cursor' | 'kilocode' | 'opencode' | 'opencode-v2' | 'kiro' | 'pi' | 'agy' | 'devin' | 'droid' | 'kimi' | 'kimchi' | 'muse' | 'amp' | 'aider' | 'grok' | 'crush' | 'auggie' | 'cline' | 'autohand'
interfaceMode'chat' | 'tui'
prUrlstring

Restrict the pass to this pull request, attaching it to the session first if AO does not track it yet (never from another active session). Omit to review every eligible PR on the session.

rejectReviewedHeadboolean

Return 409 instead of reusing when every open PR head is already being reviewed or already has a review.

rerunboolean

Start a fresh pass for already-reviewed current heads; a different reviewer may run alongside one that is still running. A person's rerun reuses an active pass from the same reviewer; an agent's rerun returns 409 REVIEW_ALREADY_RUNNING instead.

source'manual' | 'agent'

Who requested the pass: manual (a person, the default) or agent (an AO session through the CLI).

Response

OK

autoInjectEnabledboolean required

True when this request turned the worker session's review auto-inject on.

createdboolean required

True when a new review pass was started; false when an existing run for the same commit was reused.

reviewerHandleIdstring required

Changes

  • 8f160e6183cdRevision changes
    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

  • b7474720de61Revision changes
    • warning

      added the new agent enum value to the /// response property for the response status

    • warning

      added the new agent enum value to the /// response property for the response status

    • warning

      added the new agent enum value to the /// response property for the response status

    • warning

      added the new agent enum value to the /// response property for the response status

    • warning

      added the new agent enum value to the // response property for the response status

    • warning

      added the new agent enum value to the // response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status