Skip to content

APIReferenceNitnem

Get a bani

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

One bani’s lines (SGGS lines by pointer, cited by Ang; labelled extra layer).

key
required
string
/^[a-z0-9_]+$/

Bani key.

variant
string

Named variant; omit for the default form.

OK

Media typeapplication/json
object
available
required
boolean
bani
required
object
key
required
string
variant
required
string
is_default
required
integer
title_gm
required
string
title_en
required
string
category
required
string
order_no
required
integer
n_lines
required
integer
n_groups
required
integer
has_extra
required
integer
estimated_minutes
required
integer
description_en
required
string
source_label
required
string
variants
required
Array<string>
ang_first
required
integer
ang_last
required
integer
lines
required
Array<object>
object
id
required
integer
ang
required
integer
raag
required
null
section
required
string
author
required
string
comp_type
required
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
markers
required
string
seq
required
integer
line_group
required
integer
source
required
string
en
string
note
required
string
Examplegenerated
{
"available": true,
"bani": {
"key": "example",
"variant": "example",
"is_default": 1,
"title_gm": "example",
"title_en": "example",
"category": "example",
"order_no": 1,
"n_lines": 1,
"n_groups": 1,
"has_extra": 1,
"estimated_minutes": 1,
"description_en": "example",
"source_label": "example"
},
"variants": [
"example"
],
"ang_first": 1,
"ang_last": 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",
"markers": "example",
"seq": 1,
"line_group": 1,
"source": "example",
"en": "example"
}
],
"note": "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"
}