Справочник API публикуется на английском языке.

Prepare GitHub App manifest registration

POST/api/chat-endpoints/{endpointId}/github/registration
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Prepare GitHub App manifest registration.

Starts or resumes a private App under a personal account or organization. Supplying ownerType uses the two-screen wizard and Cloud callbacks, including localhost; omitting it preserves legacy direct registration. State remains bound to the member, organization, draft, connection, agent, and trusted origin. Credentials are never returned.

Авторизация

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. Как работают ключи.

Параметры пути

endpointIdstring (uuid)ОбязательныйThe endpoint's id.

Тело запроса

application/json · обязательно

namestringОбязательный1–34 characters
ownerTypestringНеобязательныйone of: "personal", "organization"
ownerLoginstringНеобязательныйpattern: ^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$

Ответы

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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Chat channels