Lewati ke konten

Proyek, tag, dan berbagi

Pustaka berkas adalah sumber kebenaran untuk sumber daya; proyek, tag, dan pencarian merupakan tampilan yang menyusunnya. Pertahankan ID berkas atau dokumen; jangan gunakan nama sebagai pengganti pengidentifikasi yang stabil.

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}

Menambahkan dokumen ke dalam proyek hanya mengubah cara pengorganisasiannya: file tidak disalin dan pemiliknya tidak berubah.

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}

Nama tag digunakan untuk tampilan; penghapusan, pemutusan, dan query menggunakan ID tag.

GET /api/v1/search?q={query}&limit=20

Pencarian hanya mengembalikan dokumen dan pekerjaan yang dapat dibaca oleh akun saat ini. Pencarian bersifat baca dan tidak memerlukan kredit.

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 membuat tautan read-only ke hasil terjemahan; badannya berisi artifact_id dan expires_in_days opsional (1–365; tanpa parameter ini, tautan tidak akan kedaluwarsa). Siapa pun yang memiliki tautan tersebut dapat mengunduhnya, jadi jauhkan tautan dari log dan parameter analitik, serta hapus saat sudah tidak diperlukan lagi.

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

Endpoint-endpoint ini digunakan untuk membangun ruang kerja terpadu bagi akun OmniDoc. Klien harus mengikuti entri dan kemampuan yang tercantum dalam respons, dan tidak boleh membuat URL aplikasi secara manual.