Skip to content

APIReferenceKnowledge

Get composition forms

Updated

Page actions

ChatGPT and Claude are third-party services. The link gives them this page's public address and a short instruction. This site records nothing.

GET
/api/forms
curl --request GET \
--url 'https://example.com/api/forms?comp_id=1'

Structural, poetic and musical form metadata for one composition.

comp_id
required
integer
<= 2147483647

Composition id.

OK

Media typeapplication/json
object
available
required
boolean
comp_id
required
integer
forms
required
object
comp_id
required
integer
raag_name
required
null
first_ang
required
integer
ghar
required
null
partaal
required
integer
has_rahao
required
integer
has_rahao_dooja
required
integer
dhunni
required
null
jati
required
null
form
required
null
pada_count
required
null
genre
required
null
source_label
required
string
note
required
string
Examplegenerated
{
"available": true,
"comp_id": 1,
"forms": {
"comp_id": 1,
"raag_name": "example",
"first_ang": 1,
"ghar": "example",
"partaal": 1,
"has_rahao": 1,
"has_rahao_dooja": 1,
"dhunni": "example",
"jati": "example",
"form": "example",
"pada_count": "example",
"genre": "example",
"source_label": "example"
},
"note": "example"
}

Invalid request (bad or out-of-range parameter).

Media typeapplication/json
object
error
required
string
Examplegenerated
{
"error": "example"
}

Internal error (generic body; details are logged, never returned).

Media typeapplication/json
object
error
required
string
Examplegenerated
{
"error": "example"
}