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

Configure or change chat endpoint lifecycle state

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

Configure or change chat endpoint lifecycle state.

Runs a setup or lifecycle action. configure and reconnect accept provider credentials (Slack: botToken, signingSecret; GitHub: appId, privateKey after Veyra Intelligence generates the webhook secret; Discord: applicationId, guildId, botToken; Microsoft Teams: clientId, tenantId, clientSecret; Telegram: botToken; iMessage Photon: projectSecret, with nonsecret photon.projectId and photon.lineId configuration). Agent-supplied signing secrets, webhook secrets, private keys, client secrets, and project secrets return a saved human credential-entry handoff without changing credentials. Authorized write-only bot tokens and API keys remain supported. Credentials are stored as Veyra Intelligence secret references and are never returned. Other actions do not require credentials.

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

actionstringObligatorioone of: "configure", "verify", "pause", "resume", "reconnect", "remove"
credentialsobject<string, string>Opcional
photonobjectOpcional

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).
429Provider request limit reached; retry laterToo many requests; wait for Retry-After seconds.
502Provider returned an invalid response; inspect provider health
503Provider temporarily unavailable; retry laterA 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