La referencia de la API se publica en inglés.

Connect an existing GitHub App

POST/api/chat-endpoints/{endpointId}/github/app
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Connect an existing GitHub App.

Agents send an empty body to receive a saved credential-entry handoff. Only a human session may import App credentials and its webhook signing key. Human import validates App identity with GitHub and vaults credentials; installation and signed webhook delivery must still be verified.

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

appIdstringOpcionalpattern: ^[1-9][0-9]*$
privateKeystringOpcional1–32000 characters
webhookSecretstringOpcional16–1024 characters
clientIdstringOpcional1–128 characters
clientSecretstringOpcional1–1024 characters

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.

Chat channels