Projekty, značky a zdieľanie
Knižnica súborov je zdrojom pravdy pre zdroje; projekty, značky a vyhľadávanie sú zobrazenia, ktoré ich organizujú. Zachovajte ID súborov alebo dokumentov; nepoužívajte názvy namiesto stabilných identifikátorov.
Projekty
Section titled “Projekty”GET /api/v1/projectsPOST /api/v1/projectsGET /api/v1/projects/{project_id}PATCH /api/v1/projects/{project_id}DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documentsDELETE /api/v1/projects/{project_id}/documents/{document_id}Pridanie dokumentu do projektu zmení iba spôsob jeho organizácie: súbor sa nekopíruje a jeho vlastník sa nemení.
Štítky
Section titled “Štítky”GET /api/v1/tagsPOST /api/v1/tagsDELETE /api/v1/tags/{tag_id}
POST /api/v1/tags/documents/{document_id}DELETE /api/v1/tags/documents/{document_id}/{tag_id}Názov značky slúži na zobrazenie; pri mazaní, odpojení a dotazovaní sa používa ID značky.
Hľadať
Section titled “Hľadať”GET /api/v1/search?q={query}&limit=20Vyhľadávanie vráti iba dokumenty a úlohy, ktoré si aktuálny účet môže prečítať. Vyhľadávanie je čítacou operáciou a nestojí žiadne kredity.
Zdieľať odkazy
Section titled “Zdieľať odkazy”GET /api/v1/sharesPOST /api/v1/sharesGET /api/v1/shares/{token}GET /api/v1/shares/{token}/downloadDELETE /api/v1/shares/{token}POST /shares vytvorí odkaz na výsledok prekladu len na čítanie; telo obsahuje artifact_id a voliteľný expires_in_days (1–365; bez neho odkaz nevyprší). Každý, kto má tento odkaz, môže súbor stiahnuť, preto ho uchovávajte mimo protokolov a analytických parametrov a odstráňte ho, keď už nie je potrebný.
Pracovný priestor aplikácie
Section titled “Pracovný priestor aplikácie”GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsTieto koncové body slúžia na vytvorenie jednotného pracovného priestoru pre účet OmniDoc. Klienti by mali používať hodnoty a funkcie uvedené v odpovediach a nemali by si sami vytvárať URL adresy aplikácií.