La référence de l'API est publiée en anglais.
Save GitHub bot review configuration
PUT
/api/chat-endpoints/{endpointId}/github/configurationPersonal API keyAgent API keyConsole session
Save GitHub bot review configuration.
Compares the configuration revision and rechecks members, sponsors, repositories, and agent tool governance. Does not change the bot's assigned agent or enable formal reviews implicitly.
Autorisation
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Fonctionnement des clés.
Paramètres de chemin
endpointIdstring (uuid)ObligatoireThe endpoint's id.
Corps de la requête
application/json · obligatoire
expectedRevisionintegerObligatoire
≥ 0configurationobjectObligatoire
configuration.versionnumberObligatoire
one of: 1configuration.toolsEnabledbooleanObligatoire
configuration.responsibleUserIdstringObligatoire
at least 1 characterconfiguration.memberAccessstringObligatoire
one of: "all_linked", "selected"configuration.peoplearray<object>Obligatoire
configuration.defaultsobjectObligatoire
configuration.defaults.invocationstringObligatoire
one of: "mentions_only", "linked_authors", "allowed_authors"configuration.defaults.eventsarray<string>Obligatoire
items one of: "opened", "synchronize", "reopened", "ready_for_review", "mention", "comment"configuration.defaults.issueOpenedbooleanFacultatif
configuration.defaults.issueOpenedInstructionsstringFacultatif
at most 12000 charactersconfiguration.defaults.reviewDraftsbooleanObligatoire
configuration.defaults.reviewBotAuthorsbooleanObligatoire
configuration.defaults.includeAuthorsarray<string>Obligatoire
each at most 256 charactersconfiguration.defaults.excludeAuthorsarray<string>Obligatoire
each at most 256 charactersconfiguration.defaults.targetBranchesarray<string>Obligatoire
each at most 256 charactersconfiguration.defaults.excludedBranchesarray<string>Obligatoire
each at most 256 charactersconfiguration.defaults.requiredLabelsarray<string>Obligatoire
each at most 256 charactersconfiguration.defaults.excludedLabelsarray<string>Obligatoire
each at most 256 charactersconfiguration.defaults.ignoredPathsarray<string>Obligatoire
each at most 256 charactersconfiguration.defaults.instructionsstringObligatoire
at most 24000 charactersconfiguration.defaults.promptsobjectObligatoire
configuration.defaults.findingCategoriesarray<string>Obligatoire
each at most 256 charactersconfiguration.defaults.minimumCommentSeveritystringObligatoire
one of: "info", "warning", "error"configuration.defaults.publishSummarybooleanObligatoire
configuration.defaults.publishInlinebooleanObligatoire
configuration.defaults.allowApprovebooleanObligatoire
configuration.defaults.allowRequestChangesbooleanObligatoire
configuration.defaults.ratingThresholdnumber | anyObligatoire
configuration.repositoriesobject<string, object>Obligatoire
Réponses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
502GitHub returned an invalid response or unavailable capability
503GitHub is temporarily unavailableA dependency is unavailable; retry with backoff.
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.