Créer une pull request avec l'API GitHub

Ouvre une pull request de la branche head vers la branche base et la renvoie, avec son number. Envoyez title, ou issue pour transformer une issue existante en pull request. Notifie les personnes qui suivent le dépôt.

Identifiant
github_create_pull_request

L'appel

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>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
ownerstringOuiLogin of the user or organization that owns the repository, the owner.login of List repositories.
repostringOuiName of the repository, the name of List repositories.
headstringOuiBranch with the changes. For a branch of a fork, write owner:branch.
basestringOuiExisting branch of this repository that receives the changes, such as main.
titlestringNonTitle of the pull request. Required unless issue is sent.
bodystringNonDescription of the pull request, in Markdown.
draftbooleanNonOpens it as a draft. In private repositories, drafts need GitHub Team or Enterprise Cloud.
maintainer_can_modifybooleanNonLets the maintainers of the base repository push to the head branch of a fork.
issueintegerNonNumber 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.

Connexions possibles

Votre client connecte son compte GitHub une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/github, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/github_create_pull_request. Il devient la définition de tool de votre agent sans conversion.

Autres tools GitHub

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.