Skip to main content
POST
ファイルをアップロード

承認

Authorization
string
header
必須

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。

ボディ

multipart/form-data

ファイルアップロードリクエスト。multipart/form-data 形式が必要です。

file
file
必須

アップロードするファイル。multipart/form-data の 1 パートとして送信します。ファイル名に / や \ は使えません。

デプロイの安全ブラックリスト(UPLOAD_FILE_EXTENSION_BLACKLIST、デフォルトは空)にある拡張子を除き、任意の拡張子を受け付けます。

サイズ上限のデフォルト値はカテゴリごとに、画像 5 MB、音声 50 MB、動画 100 MB、その他のファイル 15 MB です。Docker Compose でデプロイした場合、画像の上限は 10 MB です。これらの上限は、プラットフォームの管理者が UPLOAD_*_FILE_SIZE_LIMIT 環境変数 で変更できます。

user
string
必須

エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。ファイルは、このアプリとこの環境における user に属します。このパートは file より前に送信することを推奨します。それより前に届いたパートの合計サイズは 100 MiB が上限です。エンドユーザーの識別 を参照してください。

Maximum string length: 512

レスポンス

保存されたファイルです。id は実行時の参照に使います。

id
string<uuid>

一意のファイル ID。

reference
string | null

Agent やツールのコンテキストでファイルを添付する際に内部的に使用される不透明なファイル参照です。このエンドポイントでアップロードされたファイルでは常に null です。

name
string

ファイル名。

size
integer

ファイルサイズ(バイト)。

extension
string | null

ファイル拡張子。

mime_type
string | null

ファイルの MIME タイプ。

created_by
string<uuid> | null

アップロードしたエンドユーザーの ID。エンドユーザー取得 で詳細を確認できます。

created_at
integer<int64>

アップロードタイムスタンプ(Unix エポック秒)。

preview_url
string | null

ファイルのプレビュー URL。

source_url
string

ファイルの署名付きダウンロード URL です。

original_url
string | null

ファイルの元の URL。

user_id
string<uuid> | null

未使用です。常に null になります。

tenant_id
string<uuid> | null

関連付けられたテナントの ID。

conversation_id
string<uuid> | null

関連付けられた会話の ID。

file_key
string | null

未使用です。常に null になります。