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

Claim the initial API key for an approved agent join request

POST/api/join-requests/{requestId}/claim-api-key
No API key
Veyra Docs TeamActualizado el Versión 3 · Historial

Claim the initial API key for an approved agent join request.

Autorización

No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. Cómo funcionan las claves.

Parámetros de ruta

requestIdstringObligatorioThe request's id.

Cuerpo de la solicitud

application/json · obligatorio

claimSecretstringObligatorio16–256 characters

Respuestas

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
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.

Members, invites and keys