Save a new music box song
create_songSaves a melody as a new private song. The melody must have no errors (run validate_melody or fit_melody_to_box first); warnings such as notes repeated too quickly are saved and marked, as in the composer. If the person is signed in, the song goes to their account and you get a link to open it in the composer. Without an account the song is saved anonymously and you get a claim link: give it to the person so they can keep it (valid 30 days). Set save_to_my_account to true to ask the person to sign in first (apps that cannot sign in mid-conversation should save without an account and give the claim link instead). Limits: 5 songs a day without an account, 15 a day with one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| box | Yes | Music box type: "15", "20", "30" (notes) or "freestyle" (digital only). See list_music_boxes. | |
| bpm | Yes | Tempo in beats per minute (30-300). | |
| name | Yes | Song title. | |
| tags | No | ||
| notes | Yes | Notes in any order, at most 2000. Only onsets matter: music boxes have no note durations. | |
| artist | Yes | Original artist or composer ("Traditional" if unknown). | |
| description | No | Optional notes about the arrangement. | |
| save_to_my_account | No | True to save it in the person's account; they will be asked to sign in if they are not. | |
| illegal_threshold_ticks | No | Minimum gap between two identical notes, in ticks (default 384 = 2 beats). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| box | Yes | ||
| quota | Yes | ||
| private | Yes | ||
| song_id | Yes | ||
| claim_url | No | ||
| validation | Yes | ||
| claim_token | No | ||
| composer_url | No | ||
| claim_expires_at | No | ||
| saved_to_account | Yes |