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

Get a chat endpoint

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

Get a chat endpoint.

Returns a chat endpoint only when it belongs to an organization accessible to the current member; an inaccessible endpoint is reported as not found.

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.

Respuestas

200SuccessThe request worked; the body holds the result.
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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Chat channels