Dự án, thẻ và chia sẻ
Thư viện tệp là nguồn thông tin chính xác duy nhất cho các tài nguyên; dự án, thẻ và chức năng tìm kiếm chỉ là các chế độ xem giúp sắp xếp chúng. Giữ nguyên ID tệp hoặc tài liệu; không sử dụng tên thay cho các định danh ổn định.
Dự án
Phần tiêu đề “Dự án”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}Việc thêm một tài liệu vào dự án chỉ thay đổi cách tổ chức của nó: tệp không bị sao chép và chủ sở hữu của tệp vẫn không thay đổi.
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}Tên thẻ dùng để hiển thị; việc xóa, tách và truy vấn sử dụng ID thẻ.
Tìm kiếm
Phần tiêu đề “Tìm kiếm”GET /api/v1/search?q={query}&limit=20Kết quả tìm kiếm chỉ bao gồm các tài liệu và công việc mà tài khoản hiện tại có thể đọc. Thao tác tìm kiếm thuộc loại đọc và không tốn tín dụng.
Chia sẻ liên kết
Phần tiêu đề “Chia sẻ liên kết”GET /api/v1/sharesPOST /api/v1/sharesGET /api/v1/shares/{token}GET /api/v1/shares/{token}/downloadDELETE /api/v1/shares/{token}POST /shares tạo một liên kết chỉ đọc đến kết quả dịch; phần thân chứa artifact_id và một expires_in_days tùy chọn (1–365; nếu không có thì liên kết không hết hạn). Bất kỳ ai có liên kết đều có thể tải xuống, vì vậy hãy tránh đưa liên kết vào nhật ký hoặc các tham số phân tích, đồng thời xóa liên kết khi không còn cần thiết.
Không gian làm việc ứng dụng
Phần tiêu đề “Không gian làm việc ứng dụng”GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsCác điểm cuối này dùng để xây dựng một không gian làm việc thống nhất cho tài khoản OmniDoc. Khách hàng nên tuân theo các mục và khả năng được trả về trong phản hồi, thay vì tự xây dựng URL ứng dụng.