コンテンツにスキップ

結果とダウンロード

GET /api/v1/artifacts?job_id={job_id}
GET /api/v1/artifacts/{artifact_id}

アーティファクトは所有アカウントのみが参照できます。ジョブの完了後にリストを確認してください。

GET /api/v1/artifacts/{artifact_id}/download
Terminal window
curl --fail-with-body -OJ \
https://omnidoc.top/api/v1/artifacts/6n2b7z5q8v4m1c3k/download \
-H "X-API-Key: $OMNIDOC_API_KEY"

ダウンロードは ETag および条件付きリクエストをサポートします。大きなファイルは一度にメモリに読み込むのではなく、ディスクにストリーム処理で書き出します。

GET /api/v1/artifacts/{artifact_id}/download-link

戻り値:

{
"mode": "direct",
"url": "https://download.example/...",
"filename": "report.en.docx"
}

クライアントは、url が null であることを処理する必要があります。その後、直接ダウンロードエンドポイントを使用してください。有効期限が切れた場合は、新しい短期間有効な URL を取得してください。

GET /api/v1/artifacts/{artifact_id}/preview-url

HTML、SVG、および XML の結果は、常に添付ファイルとしてダウンロードされます。

まず RFC 5987 filename* を解析し、それでも対応できない場合は filename にフォールバックします。いずれを使用する場合も、ファイル名の基本部分のみを保持し、ローカルのファイルシステムに従って不正な文字を切り捨てまたは置換してください。

ジョブは複数のアーティファクトまたは1つのパッケージ化された結果を返すことがあります。アーティファクトリストおよびダウンロード応答ヘッダーに記載されたformatに基づいて判断し、ソースファイルの拡張子から応答タイプを推測しないでください。