Task a single-use workspace login handoff

POST/api/execution-workspaces/{id}/login-handoff
Personal API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Task a single-use workspace login handoff.

Mints a short-lived, single-use ticket the isolated workspace exchanges for its own instance-scoped session, so opening a managed workspace does not depend on a cloned password. Board actors only. The response url must be navigated to, not stored: the workspace answers it with a redirect so the ticket never enters browser history. A refusal carries a machine reason and, where the control plane probed it, the workspace's own readiness.

Authorization

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. How keys work.

Path parameters

idstringRequiredThe execution workspace's id.

Request body

application/json · required

nextstringOptional

Responses

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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
501Internal server error

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Workspaces