Save to OffStereo
save_to_offstereoSave the exact existing playlist preview or listening selection privately to OffStereo, without creating an Apple Music playlist, researching, rematching, or starting playback. Pass playlistId from create_playlist(previewOnly=true), or sessionId from the active player. Repeated saves of the same selection return the same saved item. The result offers Continue to Apple Music on the website, where the listener explicitly saves using their browser's Apple session. Preserve videos and other media on OffStereo; only matched songs are eligible for Apple export. Call only after the listener asks to save.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| requestId | No | Optional application correlation id for the save receipt. It does not change retry identity. | |
| sessionId | No | Exact id of the listening selection already open in the player. | |
| playlistId | No | Exact draft id from the playlist preview. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| title | No | ||
| object | Yes | Always 'playlist'. | |
| status | Yes | preview, preview_partial, saved_offstereo, created, partial, auth_required, or failed. | |
| tracks | No | ||
| webUrl | No | ||
| actions | No | ||
| message | No | ||
| privacy | No | Requested vs. confirmed privacy state. | |
| service | No | ||
| spotify | No | ||
| warnings | No | ||
| retryTool | No | ||
| appleMusic | No | ||
| authReason | No | ||
| connectUrl | No | Sign-in URL when status is auth_required. | |
| unresolved | No | Songs that could not be confidently matched. | |
| connections | No | ||
| pendingActionId | No | Retry token for a safe re-call after sign-in. |