Projekty, tagi i udostępnianie
Biblioteka plików jest źródłem prawdy dla zasobów; projekty, tagi i wyszukiwanie to widoki, które je organizują. Zachowaj identyfikatory plików lub dokumentów; nie używaj nazw zamiast stabilnych identyfikatorów.
Projekty
Dział zatytułowany „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}Dodanie dokumentu do projektu zmienia jedynie jego organizację: plik nie jest kopiowany, a jego właściciel pozostaje bez zmian.
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}Nazwa tagu służy do wyświetlania; usuwanie, odłączanie i zapytywanie wykorzystują identyfikator tagu.
GET /api/v1/search?q={query}&limit=20Wyszukiwanie zwraca tylko dokumenty i zadania, do których aktualne konto ma dostęp. Wyszukiwanie jest operacją odczytu i nie kosztuje żadnych kredytów.
Udostępnij linki
Dział zatytułowany „Udostępnij linki”GET /api/v1/sharesPOST /api/v1/sharesGET /api/v1/shares/{token}GET /api/v1/shares/{token}/downloadDELETE /api/v1/shares/{token}POST /shares tworzy link tylko do odczytu do wyniku tłumaczenia; w treści znajduje się artifact_id oraz opcjonalny expires_in_days (1–365; bez niego link nie wygasa). Każdy, kto posiada ten link, może go pobrać, dlatego należy unikać umieszczania go w logach i parametrach analitycznych oraz usuwać go po zakończeniu jego potrzeby.
Przestrzeń robocza aplikacji
Dział zatytułowany „Przestrzeń robocza aplikacji”GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsTe punkty końcowe służą do tworzenia zintegrowanego obszaru roboczego dla konta OmniDoc. Klienci powinni kierować się wpisami i funkcjami zawartymi w odpowiedziach, a nie samodzielnie budować adresy URL aplikacji.