Verify a quotation

GET

/api/verify

curl --request GET \
  --url 'https://example.com/api/verify?q=example'

• Same origin as the web app (the gateway routes /api/*).

Is this quotation really in the Granth? Returns a verdict, confidence and the matched line.

Parameters

Query Parameters

q

required

string

>= 1 characters <= 600 characters

The quotation to verify.

ang

integer

>= 1 <= 1430

Claimed Ang, checked against the match.

Responses

200

OK

Media typeapplication/json

object

verdict

required

string

confidence

required

number

matched_line_id

required

Any of:

integer

integer

null

null

distance_details

required

object

best_ratio

required

number

second_ratio

required

number

gap

required

number

candidates_scored

required

integer

ang

required

Any of:

integer

integer

null

null

gurmukhi

required

Any of:

null

null

string

string

raag

required

null

author

required

Any of:

null

null

string

string

comp_id

required

Any of:

integer

integer

null

null

section

required

Any of:

null

null

string

string

Example^generated

{
  "verdict": "example",
  "confidence": 1,
  "matched_line_id": 1,
  "distance_details": {
    "best_ratio": 1,
    "second_ratio": 1,
    "gap": 1,
    "candidates_scored": 1
  },
  "ang": 1,
  "gurmukhi": "example",
  "raag": "example",
  "author": "example",
  "comp_id": 1,
  "section": "example"
}

400

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

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

500

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

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}