Transcribe music
transcribe_musicMake a new score from one source: file (an attachment), url (a public recording or video) or score_id (its recording transcribed again, only when the user asks, never merely to fix notation). Audio or video is the whole piece: 10 credits when it first opens (30 seconds or less: free).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bpm | No | Quarter notes per minute, only if user-supplied or source-established (dotted quarters times 1.5); otherwise detected. File or url only. | |
| url | No | A public https link: a video or song page (YouTube, Bilibili, Instagram and similar), a file, Dropbox or Drive. At most 95 MiB; a long video gives its opening minutes. For a video, inspect its frames first: readable sheet music is written from notation unless the performance is wanted; no sheet music means transcribe it here. | |
| file | No | The attached file as the host gives it. A PDF or image is read whole: also 10 credits (30 seconds or less: free). MusicXML, MIDI, ABC and Guitar Pro open free; an edited copy of an existing score is saved into that score. | |
| view | No | staff, jianpu (1 = the key, movable do), jianpu_fixed (1 = C, fixed do) or jianpu_melody (top line only). With score_id, the original's by default. | |
| consent | No | With score_id: true only after the user approved those credits. | |
| credits | No | With score_id: the credits the user approved, as needs_confirmation reported them. | |
| preview | No | true: a free 30-second preview instead of the whole piece, only when the user asks to try one first. | |
| provider | No | local (one instrument or voice), piano (solo piano) or mirelo (a band: uses credits, priced first). | local |
| score_id | No | A finished score, or a stopped task by its job_id, whose recording the user wants transcribed again (such as with corrected instruments or another engine); the original stays. It can use credits again: without credits and consent=true it returns needs_confirmation and creates nothing. | |
| pro_options | No | Band (Pro) rhythm and paper choices, each optional: only user-supplied or source-established ones. Pass a source-established time_signature: omission uses N/4 and never detects 6/8, 9/8 or 12/8. Otherwise timing performance (quantized snaps to a reliable beat), subdivision found by Pro, tempo follow (fixed: one tempo, at bpm), page_size a4. | |
| replay_only | No | Test accounts only: reuse an exact saved band result, never new processing. | |
| review_instruments | No | Band only: true (default) holds it for the instrument list before the price. |