Skip to main content

API routes

The API is being designed and developed, with priority on current needs. Specifications are available in redoc (which is better formatted visually) and swagger (which allows you to try the API via the interface).

Here is a list of the current routes (last update: 15.07.2022). Routes that are in development are available to try but not yet thoroughly tested and subject to changes, while those in design can be browsed for (provisional) specifications but are not yet implemented. The routes that are not read-only have restricted access.

Route Status Read-only Description
/search/form/ development yes search for word forms by string
/retrieve/lexeme/:lexeme_id/ development yes no
/search/lexeme/ design yes search for lexemes
/search/lexical-unit/ design yes search for lexical units
/retrieve/lexical-unit-lexemes/ design yes get the lexical unit's component lexemes
/process/string-to-tokens/ development yes parse a Slovene string to get a list of tokens
/create/lexeme/ development no get or create a lexeme based on defining properties
/create/lexical-unit/ design no get or create a lexical unit based on properties and components
/detach/lexical-unit/ development no detach a lexical unit from a resource