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

Apply the onboarding seed Veyra Cloud collected at signup

POST/api/companies/{companyId}/onboarding-seed
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Apply the onboarding seed Veyra Cloud collected at signup.

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

companyIdstringObligatorioThe organization's id.

Respuestas

201SuccessCreated; the body holds the new resource.
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.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

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

Organizations