Skip to content

Create a song

POST
/api/songs
object
id
string format: uuid
title
required
string
>= 1 characters <= 500 characters
artist
string
<= 500 characters
key
string
<= 20 characters /^[A-G][b#]?(m|min|maj|dim|aug|sus[24]?|add\d+|\/[A-G][b#]?)?$/i/
tempo
integer
>= 20 <= 400
duration
integer
<= 3600
content
string
<= 100000 characters
notes
string
<= 10000 characters
timeSignature
string
<= 20 characters
leadVocal
string
<= 200 characters
infoPa
string
<= 5000 characters
mediaUrl
string
<= 500 characters
tags
Array<string>
<= 20 items
midiClipUrl
Any of:
string format: uri
<= 500 characters
midiClipPath
string
<= 500 characters
midiClipName
string
<= 200 characters
midiClipDeviceId
string format: uuid
midiClipLoopCount
integer
nullable
twoColumnLayout
boolean
leadSheetUrl
Any of:
string format: uri
<= 500 characters
leadSheetPath
string
<= 500 characters
leadSheetType
string
Allowed values: pdf png jpg
leadSheetUploadedAt
string format: date-time
stepsEnabled
boolean
clickTrackEnabled
boolean
backingTrackUrl
Any of:
string format: uri
<= 500 characters
backingTrackPath
string
<= 500 characters
backingTrackName
string
<= 200 characters
backingTrackUploadedAt
string format: date-time
backingTrackLoopCount
integer
nullable
preferredRecordingId
string format: uuid
nullable

Created

object
ok
required
boolean
data
nullable

Invalid input or no band

object
ok
required
boolean
error
required
string
code
string

Song limit reached

object
ok
required
boolean
error
required
string
code
string

Server error

object
ok
required
boolean
error
required
string
code
string