1. Docs
2. /
3. Tool reference
4. /
5. Music
6. /
7. importAudioToLibrary

Music

importAudioToLibrary

Import Audio to My Music

Import a finished song into the user's own Cloud "My Music" library from a public audio URL or an already-uploaded file.

writeexternal

Arguments

• albumIdstringoptionalAlbum id (from createMusicAlbum) to group this track under
• albumTitlestringoptionalAlbum title to create-or-reuse and group under (ignored when albumId is set)
• artiststringoptionalArtist / performer (optional)
• consentbooleanrequiredThe owner's explicit consent to import this audio into their library. Must be true: never assume consent.
• durationMsnumberoptionalTrack length in milliseconds, if known
• modelstringrequiredProvenance: the model or instrument behind it (e.g. "Session Studio v1", "Human").
• rolestringrequiredProvenance: the human/agent role behind the track (e.g. "Producer", "Composer").
• storageIdstringoptionalConvex storage id of an already-uploaded audio file. Provide this OR url, not both.
• surfacestringrequiredProvenance: the surface pattern it came through (e.g. "session-to-song").
• titlestringrequiredSong title
• urlstringoptionalPublic http(s) URL of the audio file to import. Provide this OR storageId, not both.

Returns

The registry does not declare a return shape.

Ask for it

The Cloud routes these requests to this verb.

• add this song to my music
• import this track into my library
• save the session's song to My Music

Pair it with

The verbs that finish the job.

• createMusicAlbum