コンテンツにスキップ

プロジェクト、タグ、および共有

ファイルライブラリはリソースの信頼できる情報源であり、プロジェクト、タグ、検索はそれらを整理するビューです。ファイルまたはドキュメントの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 を自ら作成しないでください。