📪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.
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)
- Their name (
Successful Response
GET / HTTP/1.1
Host:
Accept: */*
Successful Response
No content
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.
Successful Response
Validation Error
GET /validity/{slug} HTTP/1.1
Host:
Accept: */*
No content
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.
remedeSuccessful Response
Validation Error
GET /phoneme/{phoneme} HTTP/1.1
Host:
Accept: */*
No content
Returns the Remède document of word.
remedeSuccessful Response
Validation Error
GET /word/{word} HTTP/1.1
Host:
Accept: */*
No content
Returns the 6 first word starting by query. Not case and accent sensible !
remedeSuccessful Response
Validation Error
GET /autocomplete/{query} HTTP/1.1
Host:
Accept: */*
No content
Returns the word starting with query. Not case and accent sensible !
0remedeSuccessful Response
Validation Error
GET /search/{query} HTTP/1.1
Host:
Accept: */*
No content
Returns the markdown file corresponding to sheet with slug slug.
Successful Response
Validation Error
GET /sheets/download/{slug} HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?