メインコンテンツへスキップ
POST
/
completion-messages
cURL
curl --request POST \
  --url 'https://{api_base_url}/completion-messages' \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: application/json' \
  --no-buffer \
  --data '{"inputs": {"city": "San Francisco"}, "response_mode": "streaming", "user": "{user}"}'
import requests

url = "https://{api_base_url}/completion-messages"

payload = {
"inputs": { "city": "San Francisco" },
"query": "Translate 'hello' to Spanish.",
"response_mode": "streaming",
"user": "abc-123",
"files": [
{
"type": "image",
"transfer_method": "remote_url",
"url": "https://example.com/logo.png"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inputs: {city: 'San Francisco'},
query: 'Translate \'hello\' to Spanish.',
response_mode: 'streaming',
user: 'abc-123',
files: [
{
type: 'image',
transfer_method: 'remote_url',
url: 'https://example.com/logo.png'
}
]
})
};

fetch('https://{api_base_url}/completion-messages', 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}/completion-messages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inputs' => [
'city' => 'San Francisco'
],
'query' => 'Translate \'hello\' to Spanish.',
'response_mode' => 'streaming',
'user' => 'abc-123',
'files' => [
[
'type' => 'image',
'transfer_method' => 'remote_url',
'url' => 'https://example.com/logo.png'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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}/completion-messages"

payload := strings.NewReader("{\n \"inputs\": {\n \"city\": \"San Francisco\"\n },\n \"query\": \"Translate 'hello' to Spanish.\",\n \"response_mode\": \"streaming\",\n \"user\": \"abc-123\",\n \"files\": [\n {\n \"type\": \"image\",\n \"transfer_method\": \"remote_url\",\n \"url\": \"https://example.com/logo.png\"\n }\n ]\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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}/completion-messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": {\n \"city\": \"San Francisco\"\n },\n \"query\": \"Translate 'hello' to Spanish.\",\n \"response_mode\": \"streaming\",\n \"user\": \"abc-123\",\n \"files\": [\n {\n \"type\": \"image\",\n \"transfer_method\": \"remote_url\",\n \"url\": \"https://example.com/logo.png\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/completion-messages")

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"] = 'application/json'
request.body = "{\n \"inputs\": {\n \"city\": \"San Francisco\"\n },\n \"query\": \"Translate 'hello' to Spanish.\",\n \"response_mode\": \"streaming\",\n \"user\": \"abc-123\",\n \"files\": [\n {\n \"type\": \"image\",\n \"transfer_method\": \"remote_url\",\n \"url\": \"https://example.com/logo.png\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "event": "message",
  "task_id": "c3800678-a077-43df-a102-53f23ed20b88",
  "id": "b01a39de-3480-4f3e-9f1e-4841a80f8e5e",
  "message_id": "9da23599-e713-473b-982c-4328d4f5c78a",
  "mode": "completion",
  "answer": "Hello World!...",
  "metadata": {
    "usage": {
      "prompt_tokens": 1033,
      "prompt_unit_price": "0.001",
      "prompt_price_unit": "0.001",
      "prompt_price": "0.0010330",
      "completion_tokens": 128,
      "completion_unit_price": "0.002",
      "completion_price_unit": "0.001",
      "completion_price": "0.0002560",
      "total_tokens": 1161,
      "total_price": "0.0012890",
      "currency": "USD",
      "latency": 0.7682376249867957
    }
  },
  "created_at": 1705407629
}

承認

Authorization
string
header
必須

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

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

ボディ

application/json

テキスト生成メッセージを作成するためのリクエストボディ。

inputs
object
必須

アプリの入力変数の値を、変数名をキーとして指定します。期待される名前と型は、アプリケーションのパラメータ情報を取得user_input_form フィールドで確認できます。

user
string
必須

エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。メッセージとファイルは、同じ user を持つリクエストにのみ表示されます。エンドユーザーの識別 を参照してください。

query
string
デフォルト:""

処理するテキストです。レガシーフィールドで、新しいアプリではこの値を inputs の中で渡します。

response_mode
enum<string>

レスポンスの返却モード。streaming(推奨)は SSE を使用します。blocking は完了後に返却します(長時間の処理では中断される場合があります)。Cloudflare のタイムアウトは 100 s です。省略した場合、デフォルトでブロッキングモードになります。

利用可能なオプション:
streaming,
blocking
files
object[]

リクエストに添付するファイルです。ローカルファイルの場合は、まず ファイルをアップロード でアップロードし、返された idupload_file_id として transfer_method: local_file で参照します。

レスポンス

リクエスト成功。コンテンツタイプと構造はリクエストの response_mode パラメータに依存します。

  • response_modeblocking の場合、 application/jsonCompletionResponse オブジェクトを返します。
  • response_modestreaming の場合、 text/event-streamChunkCompletionEvent オブジェクトのストリームを返します。
event
string

イベントタイプ。message に固定されています。

task_id
string<uuid>

リクエスト追跡および 生成を停止 API 用のタスク ID です。

id
string<uuid>

このレスポンスイベントの一意 ID です。

message_id
string<uuid>

一意のメッセージ ID です。フィードバックや推奨質問のエンドポイントを呼び出す際に message_id パラメータとして使用します。

mode
string

アプリモード、completion 固定です。

answer
string

完全なレスポンスコンテンツ。

metadata
object

使用量と検索リソースを含むメタデータ。

created_at
integer<int64>

メッセージ作成タイムスタンプ(Unix エポック秒)。