Skip to content
Sri Guru Granth Sahib Ji — Knowledge Base

APIReferenceSearch

Search the Granth

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.

https://docs.gurbanisoul.com/api/reference/operations/search/

GET
/api/search
curl --request GET \
  --url 'https://example.com/api/search?q=example&mode=auto&limit=50&offset=0'

Search the Granth through the ranked waterfall (exact FTS, seeker lexicon, variants, English, passage, fold).

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
q
required
string
<= 300 characters

Query in Gurmukhi, romanised Gurmukhi or English.

mode
string
default: auto
Allowed values: auto gurmukhi roman english first theme

Search mode.

limit
integer
default: 50 <= 200

Page size (clamped).

offset
integer
0 <= 1000000

Page offset (clamped).

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
mode
required
string
results
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
matched_term
string
related_themes
required
Array<string>
concept
object
name
required
string
terms
required
Array<string>
description
required
string
total
required
integer
Examplegenerated
{
  "mode": "example",
  "results": [
    {
      "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",
      "matched_term": "example"
    }
  ],
  "related_themes": [
    "example"
  ],
  "concept": {
    "name": "example",
    "terms": [
      "example"
    ],
    "description": "example",
    "total": 1
  }
}

400

Section titled “400”

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

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

500

Section titled “500”

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

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

Sri Guru Granth Sahib Ji — Knowledge Base wiki. Generated from commit c3d9360. Updated 24 October 2026. This copy may be out of date; the page is at https://docs.gurbanisoul.com/api/reference/operations/search/