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

Get my primary agent

GET/api/companies/{companyId}/primary-agent/me
Personal API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Get my primary agent.

Uses the authenticated member's personal organization preference. Active organization viewers may manage their own preference. Agent credentials cannot access it. In the human UI, open the chosen agent's profile and select its crown control (Set as my primary). Confirm the replacement when a primary is already set. The Chat picker opens conversations and does not change this preference. Setting a primary requires a visible, approved, non-terminated agent and rejoins that agent under existing membership rules. A cleared preference retains its initialization state.

Autorización

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Cómo funcionan las claves.

Parámetros de ruta

companyIdstring (uuid)ObligatorioThe organization's id.

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.

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

Agents