La référence de l'API est publiée en anglais.

Save GitHub bot review configuration

PUT/api/chat-endpoints/{endpointId}/github/configuration
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

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≥ 0
configurationobjectObligatoire
configuration.versionnumberObligatoireone of: 1
configuration.toolsEnabledbooleanObligatoire
configuration.responsibleUserIdstringObligatoireat least 1 character
configuration.memberAccessstringObligatoireone of: "all_linked", "selected"
configuration.peoplearray<object>Obligatoire
configuration.defaultsobjectObligatoire
configuration.defaults.invocationstringObligatoireone of: "mentions_only", "linked_authors", "allowed_authors"
configuration.defaults.eventsarray<string>Obligatoireitems one of: "opened", "synchronize", "reopened", "ready_for_review", "mention", "comment"
configuration.defaults.issueOpenedbooleanFacultatif
configuration.defaults.issueOpenedInstructionsstringFacultatifat most 12000 characters
configuration.defaults.reviewDraftsbooleanObligatoire
configuration.defaults.reviewBotAuthorsbooleanObligatoire
configuration.defaults.includeAuthorsarray<string>Obligatoireeach at most 256 characters
configuration.defaults.excludeAuthorsarray<string>Obligatoireeach at most 256 characters
configuration.defaults.targetBranchesarray<string>Obligatoireeach at most 256 characters
configuration.defaults.excludedBranchesarray<string>Obligatoireeach at most 256 characters
configuration.defaults.requiredLabelsarray<string>Obligatoireeach at most 256 characters
configuration.defaults.excludedLabelsarray<string>Obligatoireeach at most 256 characters
configuration.defaults.ignoredPathsarray<string>Obligatoireeach at most 256 characters
configuration.defaults.instructionsstringObligatoireat most 24000 characters
configuration.defaults.promptsobjectObligatoire
configuration.defaults.findingCategoriesarray<string>Obligatoireeach at most 256 characters
configuration.defaults.minimumCommentSeveritystringObligatoireone 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.

Chat channels