session.start
Start a metered desktop session on a USABLE rig from rigs.list. Side effects: begins wall-clock billing, shows an on-screen “API session active” indicator, enables observe/input until session.end. Idle sessions auto-end after ~15 minutes. Always call session.end when done or abandoning. Do not call if no USABLE rig exists. Returns session_id and Live View URL (owner console login required).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rig_id | Yes | Rig id from rigs.list (must be online with api_access_enabled) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | False when the tool failed | |
| message | Yes | Human-readable result for the agent |