Przejdź do głównej zawartości

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.

GET /api/v1/projects
POST /api/v1/projects
GET /api/v1/projects/{project_id}
PATCH /api/v1/projects/{project_id}
DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documents
DELETE /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/tags
POST /api/v1/tags
DELETE /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=20

Wyszukiwanie zwraca tylko dokumenty i zadania, do których aktualne konto ma dostęp. Wyszukiwanie jest operacją odczytu i nie kosztuje żadnych kredytów.

GET /api/v1/shares
POST /api/v1/shares
GET /api/v1/shares/{token}
GET /api/v1/shares/{token}/download
DELETE /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.

GET /api/v1/workspace/files
GET /api/v1/workspace/entries
GET /api/v1/workspace/apps

Te 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.