Divvun API Documentation

Introduction

Welcome to the Divvun API documentation. This API provides endpoints for interacting with the Divvun service.

Base URL

All API endpoints are relative to the base URL:

https://dev.api.giellalt.org

Endpoints

Health Check

GET /health application/json

Check the health status of the API.

Response

{
    "status": "ok"
}

Grammar Check

POST /grammar/:tag application/json

Check grammar for text. Available languages:

apu - Apurinã
ba - башҡорт теле‎ (Başķort tele), башҡортса‎ (Başķortsa)
bxr - Russia Buriat
crk - ᓀᐦᐃᔭᐍᐏᐣ, Nēhiyawēwin
de - Deutsch
est-x-plamk - EST-X-PLAMK
fit - Meänkieli (Tornedalen Finnish)
fkv - Kven Finnish
fo - føroyskt
ga - Gaeilge
hdn - Xaad Kil
ik - Inupiaq
izh - Ingrian
koi - Komi-Permyak
kpv - Komi-Zyrian
krl - Karelian
kw - kernewek
liv - Livõ kel
lv - latviešu
mdf - Moksha
mhr - Eastern Mari
mns - Ма̄ньщи
mrj - Western Mari
myv - Erzya
nb - norsk bokmål
nio - Nganasan
nn - nynorsk
nno-x-ext-apertium - NNO-X-EXT-APERTIUM
oj - Ojibwa
olo - Livvin kieli
rmf - Kaalengo tšibbaha
ro - română
ru - русский
se - davvisámegiella
sje - Bidumsámegiella
sma - åarjelsaemien gïele
smn - anarâškielâ
so - Soomaali
spa-x-ext-apertium - SPA-X-EXT-APERTIUM
tt - татар
tyv - тыва‎ (tyva), тыва дыл‎ (tyva dyl)
udm - Udmurt
vep - Veps
vot - Votic
vot-x-ext-kkankain - VOT-X-EXT-KKANKAIN
vro - Võro kiil
yrk - Nenets

Request application/json

{
    "text": "sami"
}

Response application/json

{
  "text": "sami",
  "errs": [
    {
      "error_text": "sami",
      "start_index": 0,
      "end_index": 4,
      "error_code": "typo",
      "description": "Ii leat sátnelisttus",
      "suggestions": [
        "sámi"
      ],
      "title": "Čállinmeattáhus"
    }
  ]
}

Spell Check

POST /speller/:tag application/json

Check spelling for text. Available languages:

fit - Meänkieli (Tornedalen Finnish)
fkv - Kven Finnish
fo - føroyskt
ga - Gaeilge
kl - kalaallisut
nb - norsk bokmål
se - davvisámegiella
sma - åarjelsaemien gïele
smj - julevsámegiella
smn - anarâškielâ
sms - nuõrttsääʹmǩiõll

Request application/json

{
    "text": "sami"
}

Response application/json

{
  "text": "sami",
  "results": [
    {
      "word": "sami",
      "is_correct": false,
      "suggestions": [
        {
          "value": "sámi",
          "weight": 14.529631
        },
        {
          "value": "sama",
          "weight": 40.2973
        },
        {
          "value": "sáme",
          "weight": 45.896103
        },
        {
          "value": "sabmi",
          "weight": 50.2973
        },
        {
          "value": "samai",
          "weight": 50.2973
        },
        {
          "value": "sapmi",
          "weight": 50.2973
        },
        {
          "value": "satmi",
          "weight": 50.2973
        },
        {
          "value": "samo",
          "weight": 55.2973
        },
        {
          "value": "samu",
          "weight": 55.2973
        },
        {
          "value": "somá",
          "weight": 56.623154
        }
      ]
    }
  ]
}