La référence de l'API est publiée en anglais.

Start an organization-scoped adapter device login

POST/api/companies/{companyId}/adapters/{type}/login-sessions
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Start an organization-scoped adapter device login.

For a managed AI Connection, omit agentId to select an eligible computer in the sign-in environment.

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.
typestringObligatoireThe type's id.

Corps de la requête

application/json · obligatoire

agentIdstring (uuid)Facultatif
aiConnectionobjectFacultatif
aiConnection.providerstringObligatoireone of: "anthropic", "openai", "xai", "google"
aiConnection.methodstringObligatoireone of: "subscription"
aiConnection.namestringObligatoire1–160 characters
aiConnection.ownershipstringObligatoireone of: "personal", "shared"
aiConnection.connectionIdstring (uuid)Facultatif
aiConnection.agentIdsarray<string (uuid)>Facultatif
aiConnection.allAgentsbooleanFacultatif
environmentIdstring (uuid)Obligatoire
ttlSecondsintegerFacultatif≥ 60≤ 86400

Réponses

201SuccessCreated; the body holds the new resource.
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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Agent runtimes