API Documentation Ingest JSON format

Recommended for software engineers only !

Draft version

 

You can use our API to ingest new tracks.

In a JSON string you specify the url where we can download the audio file and the metadata.

 

Mandatory fields in the JSON string are:

field comment
id_client unique identifier for a track in your system
url_audio the url where we can download the audio file. If the file is on AWS S3 and not public, create a signed url valid for 7 days.
url_album_image the url where we can download the album image. If the file is on AWS S3 and not public, create a signed url valid for 7 days.
label_name name of the label or catalog
album_name name of the album
title the title of the track
composer the composer(s) of the track. if you list the writers/composers in the writers array (first_name, last_name...), too, we will use that information instead and you can omit the field composer.

 

All other fields are optional.

 

All fields are type string except:

field type
track_number int
bpm int
ownership_share int

 

Webhooks

Specify the hook_url field in the request. The processing pipeline will call this URL once it processes the track.

 

JSON example:

{
"hook_url":"https://www.yourdomain.com/api/hook/",
"id_client":"your-client-id",
"url_audio": "https://cndcdn.s3.us-west-1.amazonaws.com/sample.wav",
"url_album_image": "https://cndcdn.s3.us-west-1.amazonaws.com/albumimage.jpg",
"label_name": "Voice",
"label_code": "",
"label_lc_name": "",
"album_name": "Voice - Compilation",
"album_code": "VMV030",
"album_description": "",
"title": "Final Hour",
"track_number": "1",
"track_version": "Full",
"has_vocals": "no",
"explicit": "no",
"music_key":"D#m",
"music_meter":"4/4",
"mainversion": "yes",
"lyrics": "dancing in the sun",
"lyrics_language": "en",
"description": "confident, attitude, assertive, bold",
"keywords": "",
"bpm": "76",
"tempo": "very slow",
"isrc": "QM-GWH-13-00040",
"iswc": "",
"release_date": "2022-12-31",
"moods": "dramatic, mysterious",
"genres": "Soundtrack, Score ; formerly music_styles",
"music_for": "Documentaries",
"style_of":"American Beauty ; formerly well_known_tunes",
"featured_instruments": "hammond ; formerly instruments",
"artist": "",
"composer": "Stefan Boettjer (GEMA),Stephan Maas (AKM)",
"publisher": "Friend Music (GEMA)",
"writers": [
{
"first_name": "STEFAN",
"last_name": "BOETTJER",
"pro_affiliation": "GEMA",
"ownership_share": "50",
"cae_ipi": ""
},
{
"first name": "STEPHAN",
"last name": "MAAS",
"pro_affiliation": "AKM",
"ownership_share": "50",
"cae_ipi": ""
}
],
"publishers": [
{
"company_name": "Friend Music",
"pro_affiliation": "GEMA",
"ownership_share": "100",
"cae_ipi": "",
"role": "Original Publisher"
}
]
}

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk