La referencia de la API se publica en inglés.
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.
Autorización
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. Cómo funcionan las claves.
Parámetros de ruta
endpointIdstring (uuid)ObligatorioThe endpoint's id.
Cuerpo de la solicitud
application/json · obligatorio
expectedRevisionintegerObligatorio
≥ 0configurationobjectObligatorio
configuration.versionnumberObligatorio
one of: 1configuration.toolsEnabledbooleanObligatorio
configuration.responsibleUserIdstringObligatorio
at least 1 characterconfiguration.memberAccessstringObligatorio
one of: "all_linked", "selected"configuration.peoplearray<object>Obligatorio
configuration.defaultsobjectObligatorio
configuration.defaults.invocationstringObligatorio
one of: "mentions_only", "linked_authors", "allowed_authors"configuration.defaults.eventsarray<string>Obligatorio
items one of: "opened", "synchronize", "reopened", "ready_for_review", "mention", "comment"configuration.defaults.issueOpenedbooleanOpcional
configuration.defaults.issueOpenedInstructionsstringOpcional
at most 12000 charactersconfiguration.defaults.reviewDraftsbooleanObligatorio
configuration.defaults.reviewBotAuthorsbooleanObligatorio
configuration.defaults.includeAuthorsarray<string>Obligatorio
each at most 256 charactersconfiguration.defaults.excludeAuthorsarray<string>Obligatorio
each at most 256 charactersconfiguration.defaults.targetBranchesarray<string>Obligatorio
each at most 256 charactersconfiguration.defaults.excludedBranchesarray<string>Obligatorio
each at most 256 charactersconfiguration.defaults.requiredLabelsarray<string>Obligatorio
each at most 256 charactersconfiguration.defaults.excludedLabelsarray<string>Obligatorio
each at most 256 charactersconfiguration.defaults.ignoredPathsarray<string>Obligatorio
each at most 256 charactersconfiguration.defaults.instructionsstringObligatorio
at most 24000 charactersconfiguration.defaults.promptsobjectObligatorio
configuration.defaults.findingCategoriesarray<string>Obligatorio
each at most 256 charactersconfiguration.defaults.minimumCommentSeveritystringObligatorio
one of: "info", "warning", "error"configuration.defaults.publishSummarybooleanObligatorio
configuration.defaults.publishInlinebooleanObligatorio
configuration.defaults.allowApprovebooleanObligatorio
configuration.defaults.allowRequestChangesbooleanObligatorio
configuration.defaults.ratingThresholdnumber | anyObligatorio
configuration.repositoriesobject<string, object>Obligatorio
Respuestas
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.
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.