LogoLogo
  • 👋Welcome
  • For the users
    • 📱Download
      • 🔄Update application
    • 📖Offline dictionaries
    • 🌐Dictionaries servers
    • ⁉️Support
  • For the developers
    • 🖥️Getting started
    • 🛠️Develop on Remède
      • 🔌Setup
      • 📁Structure
      • 🧸Development
      • ⚙️API
      • ✨Features
        • ✈️Offline
        • 📒Sheets
        • 🧰DICT Client
      • Android development
    • 📪API
  • Database
    • 🗃️Database
      • 📋Database schema
      • 🗒️Document schema
      • 📦Dataset
      • 🎶Rimes
      • 📍Internationalization
        • 🇬🇧English database
    • 🚧Build Dictionary
      • The building lifecycle
      • Generate my own database
      • About
    • 📌Remède for your project
    • 📎Available formats
      • DICT
      • XDXF
      • CSV
    • ©️Credits
  • Project
    • 📜Story
    • 🙏Contributing
      • 🌐Translation
    • 👣Lifecycles and infrastructure
    • ⏭️Remède Next
Powered by GitBook

Find us

  • Website
  • Github
  • Support

© 2025 The Remède Project and its contributors.

On this page

Was this helpful?

Edit on GitHub
  1. For the developers

API

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

PreviousAndroid developmentNextDatabase

Last updated 3 months ago

Was this helpful?

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

📪

Root

get

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)
Responses
200
Successful Response
application/json
Responseany
get
GET / HTTP/1.1
Host: 
Accept: */*
200

Successful Response

No content

Get Validity

get

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.

Path parameters
slugstringRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /validity/{slug} HTTP/1.1
Host: 
Accept: */*

No content

Get Words By Phoneme

get

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.

Path parameters
phonemestringRequired
Query parameters
databasestringOptionalDefault: remede
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /phoneme/{phoneme} HTTP/1.1
Host: 
Accept: */*

No content

Get Word Document

get

Returns the Remède document of word.

Path parameters
wordstringRequired
Query parameters
databasestringOptionalDefault: remede
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /word/{word} HTTP/1.1
Host: 
Accept: */*

No content

Get Random Word Document

get

Returns a random word.

Query parameters
databasestringOptionalDefault: remede
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /random HTTP/1.1
Host: 
Accept: */*

No content

Get Word Of Day

get

Returns the word of day.

Query parameters
databasestringOptionalDefault: remede
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /word-of-day HTTP/1.1
Host: 
Accept: */*

No content

Get Autocomplete

get

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

Path parameters
querystringRequired
Query parameters
databasestringOptionalDefault: remede
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /autocomplete/{query} HTTP/1.1
Host: 
Accept: */*

No content

Get Search Results

get

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

Path parameters
querystringRequired
Query parameters
pageintegerOptionalDefault: 0
databasestringOptionalDefault: remede
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /search/{query} HTTP/1.1
Host: 
Accept: */*

No content

Send New Word

get

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

Path parameters
querystringRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /ask-new-word/{query} HTTP/1.1
Host: 
Accept: */*

No content

Get Cheatsheets

get

Returns all grammar & orthography sheets.

Responses
200
Successful Response
application/json
Responseany
get
GET /sheets HTTP/1.1
Host: 
Accept: */*
200

Successful Response

No content

Get Cheatsheet By Slug

get

Returns the grammar sheet / orthography with slug slug.

Path parameters
slugstringRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /sheets/{slug} HTTP/1.1
Host: 
Accept: */*

No content

Download Cheatsheet By Slug

get

Returns the markdown file corresponding to sheet with slug slug.

Path parameters
slugstringRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /sheets/download/{slug} HTTP/1.1
Host: 
Accept: */*

No content

Download Database

get

Download the Sqlite database as a file.

Query parameters
variantstringOptionalDefault: remede
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /download HTTP/1.1
Host: 
Accept: */*

No content

Download Binary

get

Download the latest builds.

Path parameters
variantstring · enumRequiredPossible values:
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
get
GET /release/{variant} HTTP/1.1
Host: 
Accept: */*

No content

  • GETRoot
  • GETGet Validity
  • GETGet Words By Phoneme
  • GETGet Word Document
  • GETGet Random Word Document
  • GETGet Word Of Day
  • GETGet Autocomplete
  • GETGet Search Results
  • GETSend New Word
  • GETGet Cheatsheets
  • GETGet Cheatsheet By Slug
  • GETDownload Cheatsheet By Slug
  • GETDownload Database
  • GETDownload Binary