Справочник API публикуется на английском языке.

Start an organization-scoped adapter device login

POST/api/companies/{companyId}/adapters/{type}/login-sessions
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Start an organization-scoped adapter device login.

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

Авторизация

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. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.
typestringОбязательныйThe type's id.

Тело запроса

application/json · обязательно

agentIdstring (uuid)Необязательный
aiConnectionobjectНеобязательный
aiConnection.providerstringОбязательныйone of: "anthropic", "openai", "xai", "google"
aiConnection.methodstringОбязательныйone of: "subscription"
aiConnection.namestringОбязательный1–160 characters
aiConnection.ownershipstringОбязательныйone of: "personal", "shared"
aiConnection.connectionIdstring (uuid)Необязательный
aiConnection.agentIdsarray<string (uuid)>Необязательный
aiConnection.allAgentsbooleanНеобязательный
environmentIdstring (uuid)Обязательный
ttlSecondsintegerНеобязательный≥ 60≤ 86400

Ответы

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

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Agent runtimes