Skip to content

APIReferenceInsights

Get semantic neighbours

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/neighbors
curl --request GET \
--url 'https://example.com/api/neighbors?line_id=1&limit=10'

Semantic neighbours of a line (exact sparse cosine; relatedness bands in the UI).

line_id
required
integer
<= 2147483647

Line id.

limit
integer
default: 10 >= 1 <= 50

Maximum neighbours.

OK

Media typeapplication/json
object
line_id
required
integer
level
required
string
source
required
string
line
required
object
id
required
integer
ang
required
integer
raag
required
null
author
required
string
comp_id
required
integer
gurmukhi
required
string
translit
required
string
en
required
string
neighbors
required
Array<object>
object
id
required
integer
score
required
number
ang
required
integer
raag
required
Any of:
null
author
required
string
comp_id
required
integer
gurmukhi
required
string
translit
required
string
en
required
string
note
required
string
Examplegenerated
{
"line_id": 1,
"level": "example",
"source": "example",
"line": {
"id": 1,
"ang": 1,
"raag": "example",
"author": "example",
"comp_id": 1,
"gurmukhi": "example",
"translit": "example",
"en": "example"
},
"neighbors": [
{
"id": 1,
"score": 1,
"ang": 1,
"raag": "example",
"author": "example",
"comp_id": 1,
"gurmukhi": "example",
"translit": "example",
"en": "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"
}