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

Start an organization-scoped adapter device login

POST/api/companies/{companyId}/adapters/{type}/login-sessions
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Start an organization-scoped adapter device login.

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

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

Cuerpo de la solicitud

application/json · obligatorio

agentIdstring (uuid)Opcional
aiConnectionobjectOpcional
aiConnection.providerstringObligatorioone of: "anthropic", "openai", "xai", "google"
aiConnection.methodstringObligatorioone of: "subscription"
aiConnection.namestringObligatorio1–160 characters
aiConnection.ownershipstringObligatorioone of: "personal", "shared"
aiConnection.connectionIdstring (uuid)Opcional
aiConnection.agentIdsarray<string (uuid)>Opcional
aiConnection.allAgentsbooleanOpcional
environmentIdstring (uuid)Obligatorio
ttlSecondsintegerOpcional≥ 60≤ 86400

Respuestas

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).

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

Agent runtimes