GitHub: Create a pull request

← Pulls operations · Get started

Operation github.pulls_create

Provider route: POST /repos/{owner}/{repo}/pulls. 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"]["pullsCreate"]>[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.pullsCreate(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(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
body	object	Required within parent
body.base	string	Required within parent	The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.
body.body	string	Optional	The contents of the pull request.
body.draft	boolean	Optional	Indicates whether the pull request is a draft. See “[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)” in the GitHub Help documentation to learn more.
body.head	string	Required within parent	The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.
body.head_repo	string	Optional	The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. Format: repo.nwo
body.issue	integer	Optional	An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. Format: int64
body.maintainer_can_modify	boolean	Optional	Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.
body.title	string	Optional	The title of the new pull request. Required unless `issue` is specified.

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 pull request — response body

Referenced models: Get a pull request — response body

Schemas

4 more schemas are linked from the tables above, on the schema pages.

Get a pull request — response body — auto merge

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The status of auto merging a pull request.
$ (anyOf 1).commit_message	string	Required within parent	Commit message for the merge commit.
$ (anyOf 1).commit_title	string	Required within parent	Title for the merge commit message.
$ (anyOf 1).enabled_by	Model	Required within parent	Expand List users — response body — item
$ (anyOf 1).merge_method	string	Required within parent	The merge method to use. Known values: merge, squash, rebase
$ (anyOf 2)	null	Alternative

Referenced models: List users — response body — item

Get a pull request — response body — links html

Field	Type	Presence	Description and constraints
$	object	Root	Hypermedia Link
href	string	Required within parent

Get an issue — response body — milestone

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Get an issue — response body — milestone / state: open, closed
$ (anyOf 2)	null	Alternative

Referenced models: Get an issue — response body — milestone / state: open, closed

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 a pull request — response body — stack

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The stack information associated with a pull request.
$ (anyOf 1).base	object	Required within parent
$ (anyOf 1).base.ref	string	Required within parent	The base ref of the stack this pull request belongs to.
$ (anyOf 1).base.sha	string	Required within parent	The base SHA of the stack this pull request belongs to.
$ (anyOf 1).id	JSON	Optional
$ (anyOf 1).id (anyOf 1)	integer	Alternative	The ID of the stack that this pull request belongs to.
$ (anyOf 1).id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).number	JSON	Optional
$ (anyOf 1).number (anyOf 1)	integer	Alternative	The number of the stack that this pull request belongs to.
$ (anyOf 1).number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).position	JSON	Optional
$ (anyOf 1).position (anyOf 1)	integer	Alternative	The one-based position of this pull request within the stack, where 1 is the bottom of the stack.
$ (anyOf 1).position (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).size	JSON	Optional
$ (anyOf 1).size (anyOf 1)	integer	Alternative	The total number of pull requests in the stack.
$ (anyOf 1).size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)	null	Alternative

List users — response body — item

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

List security manager teams — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Groups of organization members that gives permissions on specified repositories.
description	JSON	Required within parent
description (anyOf 1)	string	Alternative	Description of the team
description (anyOf 2)	null	Alternative
enterprise_id	JSON	Optional
enterprise_id (anyOf 1)	integer	Alternative	Unique identifier of the enterprise to which this team belongs
enterprise_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the team
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ldap_dn	string	Optional	Distinguished Name (DN) that team maps to within LDAP environment
members_url	string	Required within parent
name	string	Required within parent	Name of the team
node_id	string	Required within parent
notification_setting	string	Optional	The notification setting the team has set
organization_id	JSON	Optional
organization_id (anyOf 1)	integer	Alternative	Unique identifier of the organization to which this team belongs
organization_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
permission	string	Required within parent	Permission that the team will have for its repositories
privacy	string	Optional	The level of privacy this team should have
repositories_url	string	Required within parent	Format: uri
slug	string	Required within parent
type	string	Required within parent	The ownership type of the team Known values: enterprise, organization
url	string	Required within parent	URL for the team Format: uri

Create a fork — response body — license

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	License Simple
$ (anyOf 1).html_url	string	Optional	Format: uri
$ (anyOf 1).key	string	Required within parent
$ (anyOf 1).name	string	Required within parent
$ (anyOf 1).node_id	string	Required within parent
$ (anyOf 1).spdx_id	JSON	Required within parent
$ (anyOf 1).spdx_id (anyOf 1)	string	Alternative
$ (anyOf 1).spdx_id (anyOf 2)	null	Alternative
$ (anyOf 1).url	JSON	Required within parent
$ (anyOf 1).url (anyOf 1)	string	Alternative	Format: uri
$ (anyOf 1).url (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.pulls_create. Catalog operation: pulls/create. 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