# API routes

The API is being designed and developed, with priority on current needs. Specifications are available in [redoc](https://ddd.cjvt.si/api/redoc) (which is better formatted visually) and [swagger](https://ddd.cjvt.si/api/swagger) (which allows you to try the API via the interface).

Here is a list of the current routes (last update: 31.03.2025). All routes are available with POST, while some of them also have GET or batch POST alternatives ([ref](https://wiki.cjvt.si/books/digital-dictionary-database-of-slovene/page/api-design)). The routes that are not read-only have restricted access.

| Route | Read-only | Description |
| --- | --- | --- |
| [/search/lexical-unit/](https://ddd.cjvt.si/api/redoc/#operation/search_lexical-unit_create) | yes | search for lexical units based on their properties and parts|
| [/retrieve/lexical-unit/](https://ddd.cjvt.si/api/redoc/#operation/retrieve_lexical-unit_create) | yes | get a lexical unit's basic data|
| [/get-or-create/lexical-unit/](hhttps://ddd.cjvt.si/api/redoc/#operation/get-or-create_lexical-unit_create) | no | get or create a lexical unit based on properties and components |
| [/export/lexical-unit/](https://ddd.cjvt.si/api/redoc/#tag/export/operation/export_lexical-units_create) | yes | get all lexical units by type | 
| [/search/lexeme/](https://ddd.cjvt.si/api/redoc/#operation/search_lexeme_create) | yes | search for lexemes |
| [/retrieve/lexeme/](https://ddd.cjvt.si/api/redoc/#operation/retrieve_lexeme_create) | yes | get a lexeme's data
| [/get-or-create/lexeme/](https://ddd.cjvt.si/api/redoc/#operation/get-or-create_lexeme_create) | no |  get or create a lexeme based on defining properties |
| [/export/lexeme/](https://ddd.cjvt.si/api/redoc/#tag/export/operation/export_lexemes_create) | yes | get all lexemes by category | 
| [/retrieve/lexical-unit-lexemes/](https://ddd.cjvt.si/api/redoc/#operation/retrieve_lexical-unit-lexemes_create) | yes | get the lexical unit's component lexemes |
| [/search/category/](https://ddd.cjvt.si/api/redoc/#operation/search_category_create) | yes | search for a lexeme's category (part of speech) by string |
| [/search/form/](https://ddd.cjvt.si/api/redoc/#operation/search_form_create) | yes | search for word forms by string |
| [/search/sense/](https://ddd.cjvt.si/api/redoc/#operation/search_sense_create) | yes | search for senses | 
| [/retrieve/lexical-unit-senses/](https://ddd.cjvt.si/api/redoc/#operation/retrieve_lexical-unit-senses_create) | yes | get the senses of a lexical unit |
| [/retrieve/lexical-unit-definitions/](https://ddd.cjvt.si/api/redoc/#tag/retrieve/operation/retrieve_lexical-unit-definitions_create) | yes | get the sense definitions of a lexical unit |
| [/retrieve/lexical-unit-sense-relations/](https://ddd.cjvt.si/api/redoc/#operation/retrieve_lexical-unit-sense-relations_create) | yes | get the sense relations of a lexical unit's senses |
| [/retrieve/lexical-unit-collocations/](https://ddd.cjvt.si/api/redoc/#operation/retrieve_lexical-unit-collocations_create) | yes | get the collocations of a lexical unit |
| [/retrieve/lexical-unit-translations/](https://ddd.cjvt.si/api/redoc/#operation/retrieve_lexical-unit-translations_create) | yes | get the translations of a lexical unit |
| [/retrieve/lexical-unit-sense-examples/](https://ddd.cjvt.si/api/redoc/#operation/retrieve_lexical-unit-sense-examples_create) | yes | get corpus examples for the senses of a lexical unit |
| [/export/lexical-unit-sense-examples/](https://ddd.cjvt.si/api/redoc/#tag/export/operation/export_lexical-unit-sense-examples_create) | yes | get all corpus examples by lexical unit type |
| [/get-or-create/resource/](https://ddd.cjvt.si/api/redoc/#operation/get-or-create_resource_create) | no | get or create a dictionary or other resource |
| [/search/resource/](https://ddd.cjvt.si/api/redoc/#operation/search_resource_create) | yes | search or list resources available |
| [/attach/lexical-unit/](https://ddd.cjvt.si/api/redoc/#operation/attach_lexical-unit_create) | no | attach a lexical unit to a resource |
| [/detach/lexical-unit/](https://ddd.cjvt.si/api/redoc/#operation/detach_lexical-unit_create) | no | detach a lexical unit from a resource |
| [/search/syntactic-structure/](https://ddd.cjvt.si/api/redoc/#operation/search_syntactic-structure_create) | yes | get the XML definitions of syntactic structures |
| [/process/string-to-tokens/](https://ddd.cjvt.si/api/redoc/#operation/process_string-to-tokens_create) | yes | parse a Slovene string to get a list of tokens |