📪API

Remède provides an API that let you browse the dictionaries databases !

The public API documentation is available at https://api-remede.camarm.fr/docs. You can also browse the OpenAPI specifications below.

Root

Returns useful information about API and datasets

• Its version
• The available dictionaries
  • Their name (name)
  • Their unique identifier (hash) (hash)
  • Their slug; used to download or search in specific database (slug)
  • The number of words in the database (total)
  • Does the database respect the Remède JSON Schema (valid)
  • Which schema does it follow (schema)
  • Database readable size (size)

get

/

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/'

200

200

No body

Successful Response

Get Validity

Returns the dictionary slug validity (true/false). It's a check to know if it follows his JSON Schema. If state is unknown returns null.

get

/validity/{slug}

Path parameters

slugstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/validity/{slug}'

200

422

200

No body

Successful Response

Get Words By Phoneme

Get th list of words with phoneme phoneme. It returns a list of tuples containing the word as the first element, and its document as the second element.

get

/phoneme/{phoneme}

Path parameters

phonemestringrequired

Query parameters

databasestring · default: remede

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/phoneme/{phoneme}'

200

422

200

No body

Successful Response

Get Word Document

Returns the Remède document of word.

get

/word/{word}

Path parameters

wordstringrequired

Query parameters

databasestring · default: remede

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/word/{word}'

200

422

200

No body

Successful Response

Get Random Word Document

Returns a random word.

get

/random

Query parameters

databasestring · default: remede

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/random'

200

422

200

No body

Successful Response

Get Word Of Day

Returns the word of day.

get

/word-of-day

Query parameters

databasestring · default: remede

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/word-of-day'

200

422

200

No body

Successful Response

Get Autocomplete

Returns the 6 first word starting by query. Not case and accent sensible !

get

/autocomplete/{query}

Path parameters

querystringrequired

Query parameters

databasestring · default: remede

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/autocomplete/{query}'

200

422

200

No body

Successful Response

Get Search Results

Returns the word starting with query. Not case and accent sensible !

get

/search/{query}

Path parameters

querystringrequired

Query parameters

pageinteger · default: 0

databasestring · default: remede

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/search/{query}'

200

422

200

No body

Successful Response

Send New Word

Save the word query as a word to add to the dictionary.

get

/ask-new-word/{query}

Path parameters

querystringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/ask-new-word/{query}'

200

422

200

No body

Successful Response

Get Cheatsheets

Returns all grammar & orthography sheets.

get

/sheets

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/sheets'

200

200

No body

Successful Response

Get Cheatsheet By Slug

Returns the grammar sheet / orthography with slug slug.

get

/sheets/{slug}

Path parameters

slugstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/sheets/{slug}'

200

422

200

No body

Successful Response

Download Cheatsheet By Slug

Returns the markdown file corresponding to sheet with slug slug.

get

/sheets/download/{slug}

Path parameters

slugstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/sheets/download/{slug}'

200

422

200

No body

Successful Response

Download Database

Download the Sqlite database as a file.

get

/download

Query parameters

variantstring · default: remede

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/download'

200

422

200

No body

Successful Response

Download Binary

Download the latest builds.

get

/release/{variant}

Path parameters

variantstring · enumrequired

Options: aarch64.dmg, aarch64.app.tar.gz, x64.dmg, x64.app.tar.gz, apk, deb, exe, msi

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/release/{variant}'

200

422

200

No body

Successful Response