get_session
Read-onlyIdempotent
Survey the running Ableton set in one call: verify the Remote Script is responding and retrieve song fields, track and scene indices, clips, and device chains to guide later targeted edits.
Instructions
Survey the running set: script handshake, song fields, tracks, clips, devices.
The call to make first. It proves the Remote Script is answering before anything
else is attempted, and it hands back the track and scene indices every other
tool here is addressed by.
Returns:
Dictionary with script handshake info, song fields, the track list with its
indices, group track indices, and clip and device detail where asked for.
Note:
The round-trip handshake takes about 450 ms, so this is the expensive read. Take
it once at the start and narrow with get_track, get_clip and get_devices
afterwards rather than calling this again between edits. Group tracks have no arm
state ('armed' returns null). If Live collection introspection reports zero
tracks, index probing is used as a fallback.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| clips | No | Sweep the Session grid for slots that hold a clip. Off, the answer covers tracks and devices but says nothing about clips, and comes back faster because no slots are probed. | |
| devices | No | Include each track device chain in the answer. | |
| max_scenes | No | How many scenes deep to probe for Session clips. A cap rather than a count: Live collections report no length, so the sweep stops here instead of at the last scene. Ignored when clips is false. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||