Create pull request with the GitHub API
Opens a pull request from the head branch into the base branch and returns it, with its number. Send title, or issue to turn an existing issue into the pull request. Notifies the watchers of the repository.
- Identifier
- github_create_pull_request
The request
POST https://connect.reportei.com/api/tools/github_create_pull_request/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"owner": "<owner>",
"repo": "<repo>",
"head": "<head>",
"base": "<base>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| owner | string | Yes | Login of the user or organization that owns the repository, the owner.login of List repositories. |
| repo | string | Yes | Name of the repository, the name of List repositories. |
| head | string | Yes | Branch with the changes. For a branch of a fork, write owner:branch. |
| base | string | Yes | Existing branch of this repository that receives the changes, such as main. |
| title | string | No | Title of the pull request. Required unless issue is sent. |
| body | string | No | Description of the pull request, in Markdown. |
| draft | boolean | No | Opens it as a draft. In private repositories, drafts need GitHub Team or Enterprise Cloud. |
| maintainer_can_modify | boolean | No | Lets the maintainers of the base repository push to the head branch of a fork. |
| issue | integer | No | Number of an issue of the repository, the number of List issues, to turn into this pull request. Its title, body and comments move to the pull request. |
Supported connections
Your customer connects their GitHub account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/github, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/github_create_pull_request. It becomes your agent's tool definition with no conversion.
Other GitHub tools
- List repositoriesGETLists the repositories the account can reach: its own, those where it is a collaborator and those of its organizations. Each item has owner.login and name, which are the owner and repo the other tools ask for. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Search issuesGETSearches issues and pull requests in every repository the account can see, with the GitHub search syntax in q. Returns total_count and items, up to 1,000 results per search; paginate with page and per_page. Each item has number, and repository_url ends with the owner and repo of the item.
- List issuesGETLists the issues of a repository, newest first. Pull requests come in the list too, marked with a pull_request key. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Get issueGETReturns an issue, with title, body, state, labels, assignees and milestone. An issue moved to another repository answers 301 with its new location.
- Create issuePOSTCreates an issue in a repository and returns it, with its number. Labels, assignees, milestone and type are silently dropped when the account has no push access to the repository. Notifies the watchers of the repository.
- Update issuePATCHChanges an issue and returns it. Only the fields sent change. To close it, send state closed with a state_reason. Labels and assignees replace the current ones, and an empty list clears them.
- List issue commentsGETLists the comments of an issue or of a pull request, oldest first. The review comments on the code of a pull request are not included. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Create issue commentPOSTAdds a comment to an issue or to a pull request and returns it. Notifies the participants.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
