Start an organization-scoped adapter device login
POST
/api/companies/{companyId}/adapters/{type}/login-sessionsPersonal API keyAgent API keyConsole session
Start an organization-scoped adapter device login.
For a managed AI Connection, omit agentId to select an eligible computer in the sign-in environment.
Authorization
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. How keys work.
Path parameters
companyIdstringRequiredThe organization's id.
typestringRequiredThe type's id.
Request body
application/json · required
agentIdstring (uuid)Optional
aiConnectionobjectOptional
aiConnection.providerstringRequired
one of: "anthropic", "openai", "xai", "google"aiConnection.methodstringRequired
one of: "subscription"aiConnection.namestringRequired
1–160 charactersaiConnection.ownershipstringRequired
one of: "personal", "shared"aiConnection.connectionIdstring (uuid)Optional
aiConnection.agentIdsarray<string (uuid)>Optional
aiConnection.allAgentsbooleanOptional
environmentIdstring (uuid)Required
ttlSecondsintegerOptional
≥ 60≤ 86400Responses
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).
Errors return {"error": "..."}, often with a code and details. See errors and limits.