ファイルをアップロード

対象アプリ：Chatflow、Workflow、新しい Agent、チャットボット、Agent、テキストジェネレーター。

ファイルをアップロードし、後続のリクエストから参照するための id を返します。ファイルはアップロードしたエンドユーザーに属し、同じ user を持つリクエストだけがそのファイルを参照できます。

アプリが実際に扱えるファイル種別は、アプリのファイルアップロード設定によって決まります。アプリケーションのパラメータ情報を取得 で確認できます。

POST /files/upload

cURL

cURL

curl --request POST \
  --url 'https://{api_base_url}/files/upload' \
  --header 'Authorization: Bearer {api_key}' \
  --form 'file=@product-photo.png' \
  --form 'user={user}'

import requests

url = "https://{api_base_url}/files/upload"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "user": "<string>" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('user', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://{api_base_url}/files/upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/files/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data; boundary=---011000010111000001101001"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/files/upload"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{api_base_url}/files/upload")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/files/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

201

uploadSuccess

{
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "reference": null,
  "name": "product-photo.png",
  "size": 204800,
  "extension": "png",
  "mime_type": "image/png",
  "created_by": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
  "created_at": 1705407629,
  "preview_url": null,
  "source_url": "https://upload.dify.ai/files/a1b2c3d4-5678-90ab-cdef-1234567890ab/file-preview?timestamp=1705407629&nonce=8b3e26a5&sign=rN5DXW3xkVGwGE5MSvptu_BhQVXpMbXWmVJ0ib0LMzI=",
  "original_url": null,
  "user_id": null,
  "tenant_id": "11223344-5566-7788-99aa-bbccddeeff00",
  "conversation_id": null,
  "file_key": null
}

Authorizations

Authorization · string · header · required

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

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

Body

multipart/form-data

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

file · file · required

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

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

サイズ上限はカテゴリごとに適用されます：画像 10 MB、音声 50 MB、動画 100 MB、その他のファイル 15 MB（デフォルト値。Dify Cloud はデフォルト値を使用）。セルフホスト環境では UPLOAD_*_FILE_SIZE_LIMIT 環境変数 で調整できます。

user · string

このアップロードが属するエンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。省略すると、共有の DEFAULT-USER に帰属します。同じ user を持つ後続のリクエストだけがこのファイルを参照できます。エンドユーザーの識別 を参照してください。

Response

201

application/json

ファイルが正常にアップロードされました。

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 になります。