Start a music stream
start_streamOpen an endless, non-repeating music stream and return its URL.
Use this instead of generating tracks when the music should never stop and never loop — a workout app, a game, a focus tool, a venue.
Only one stream exists per client at a time: calling this again replaces the running one rather than opening a second. Streaming is metered by seconds played, and metering is reported after the fact, so a quota can be overshot slightly.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bitrate | No | ||
| intensity | No | low, medium or high. Changeable later. | |
| stream_type | No | 'http' for a normal audio player, 'webrtc' for low latency. | http |
| playlist_index | Yes | Channel from list_playlists, e.g. '4.0.0'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | Yes | ||
| type | Yes | ||
| security | Yes | Why this URL must be handled as a credential. | |
| stream_url | Yes | ||
| playlist_index | Yes |