GitHub: Create a review for a pull request

← Pulls operations · Get started

Operation github.pulls_create_review

Provider route: POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["pulls"]["pullsCreateReview"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.pulls.pullsCreateReview(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.pulls.pulls_create_review(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
path.pull_number	integer	Required within parent
body	object	Optional
body.body	string	Optional	Required when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.
body.comments	array	Optional	Use the following table to specify the location, destination, and contents of the draft review comment.
body.comments[]	object	Each item
body.comments[].body	string	Required within parent	Text of the review comment.
body.comments[].line	integer	Optional
body.comments[].path	string	Required within parent	The relative path to the file that necessitates a review comment.
body.comments[].position	integer	Optional	The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first ”@@” hunk header in the file you want to add a comment. The line just below the ”@@” line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
body.comments[].side	string	Optional
body.comments[].start_line	integer	Optional
body.comments[].start_side	string	Optional
body.commit_id	string	Optional	The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.
body.event	string	Optional	The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. One of: APPROVE, REQUEST_CHANGES, COMMENT

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get a review for a pull request — response body

Referenced models: Get a review for a pull request — response body

Schemas

Get a review for a pull request — response body

Field	Type	Presence	Description and constraints
$	object	Root	Pull Request Reviews are reviews on pull requests.
_links	object	Required within parent
_links.html	object	Required within parent
_links.html.href	string	Required within parent
_links.pull_request	object	Required within parent
_links.pull_request.href	string	Required within parent
author_association	string	Required within parent	How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER
body	string	Required within parent	The text of the review.
body_html	string	Optional
body_text	string	Optional
commit_id	JSON	Required within parent
commit_id (anyOf 1)	string	Alternative	A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.
commit_id (anyOf 2)	null	Alternative
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the review Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
node_id	string	Required within parent
pull_request_url	string	Required within parent	Format: uri
state	string	Required within parent
submitted_at	string	Optional	Format: date-time
user	Model	Required within parent	Expand Get an issue — response body — user

Referenced models: Get an issue — response body — user

Get an issue — response body — user

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Get an issue — response body — user A Git Hub user
$ (anyOf 2)	null	Alternative

Referenced models: Get an issue — response body — user A Git Hub user

Get an issue — response body — user A Git Hub user

Field	Type	Presence	Description and constraints
$	object	Root	A GitHub user.
avatar_url	string	Required within parent	Format: uri
email	JSON	Optional
email (anyOf 1)	string	Alternative
email (anyOf 2)	null	Alternative
events_url	string	Required within parent
followers_url	string	Required within parent	Format: uri
following_url	string	Required within parent
gists_url	string	Required within parent
gravatar_id	JSON	Required within parent
gravatar_id (anyOf 1)	string	Alternative
gravatar_id (anyOf 2)	null	Alternative
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
login	string	Required within parent
name	JSON	Optional
name (anyOf 1)	string	Alternative
name (anyOf 2)	null	Alternative
node_id	string	Required within parent
organizations_url	string	Required within parent	Format: uri
received_events_url	string	Required within parent	Format: uri
repos_url	string	Required within parent	Format: uri
site_admin	boolean	Required within parent
starred_at	string	Optional
starred_url	string	Required within parent
subscriptions_url	string	Required within parent	Format: uri
type	string	Required within parent
url	string	Required within parent	Format: uri
user_view_type	string	Optional

Policy, approvals and errors

SDK function policy ID: github.pulls_create_review. Catalog operation: pulls/create-review. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source