Skip to content

APIReferenceScripture

Get a composition

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/shabad/{comp_id}
curl --request GET \
--url https://example.com/api/shabad/1

Every verbatim line of one composition, heading run included.

comp_id
required
integer
<= 2147483647

Composition id.

OK

Media typeapplication/json
object
comp_id
required
integer
lines
required
Array<object>
object
id
required
integer
ang
required
integer
raag
required
Any of:
null
section
required
Any of:
null
author
required
string
comp_type
required
Any of:
null
comp_id
required
integer
line_no
required
integer
is_rahao
required
integer
is_header
required
integer
gurmukhi
required
string
translit
required
string
stanza_index
required
integer
pada_total
required
integer
source_category
required
string
en
string
Examplegenerated
{
"comp_id": 1,
"lines": [
{
"id": 1,
"ang": 1,
"raag": "example",
"section": "example",
"author": "example",
"comp_type": "example",
"comp_id": 1,
"line_no": 1,
"is_rahao": 1,
"is_header": 1,
"gurmukhi": "example",
"translit": "example",
"stanza_index": 1,
"pada_total": 1,
"source_category": "example",
"en": "example"
}
]
}

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

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

Not found.

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"
}