跳到內容

專案、標籤與分享

檔案庫是資源的真實值;專案、標籤和搜尋是資源的組織視圖。呼叫端應保留檔案或文件 ID,勿以名稱取代穩定識別碼。

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}

將文件加入專案僅改變組織關係,不會複製檔案,也不會變更文件所有者。

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}

標籤名是展示內容;刪除、解綁和查詢使用標籤 ID。

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

搜尋結果僅返回當前帳號有權讀取的文件和任務。搜尋屬於讀取作業,不會扣減積分。

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 為翻譯結果創建唯讀連結,請求體為 artifact_id 和可選的 expires_in_days(1–365,不傳則長期有效)。持有連結即可下載,請勿寫入日誌或分析參數,不再需要時刪除。

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

這組介面用於構建 OmniDoc 帳號下的統一工作台。用戶端應以回應中的入口和能力為準,勿自行拼接應用程式 URL。