La référence de l'API est publiée en anglais.
Apply the onboarding seed Veyra Cloud collected at signup
POST
/api/companies/{companyId}/onboarding-seedPersonal API keyAgent API keyConsole session
Apply the onboarding seed Veyra Cloud collected at signup.
Autorisation
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. Fonctionnement des clés.
Paramètres de chemin
companyIdstringObligatoireThe organization's id.
Réponses
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).
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.