完了メッセージを送信

テキスト生成アプリケーションにリクエストを送信します。

POST /completion-messages

cURL

streaming_example

curl --request POST \
  --url https://{api_base_url}/completion-messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "inputs": {
    "city": "San Francisco"
  },
  "query": "Translate 'hello' to Spanish.",
  "response_mode": "streaming",
  "user": "abc-123",
  "files": [
    {
      "type": "image",
      "transfer_method": "remote_url",
      "url": "https://cloud.dify.ai/logo/logo-site.png"
    }
  ]
}
EOF

200

blockingResponse

{
  "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
}

Authorizations

Authorization · string · header · required

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

Body

application/json

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

inputs · object · required

アプリで定義されたさまざまな変数の値を入力できます。キーと値のペアを含み、各キーは特定の変数に対応し、各値はその変数の具体的な値です。アプリが期待する変数名と型については、アプリケーションのパラメータ情報を取得 レスポンスの user_input_form フィールドを参照してください。

user · string · required

ユーザー識別子。アプリケーション内で一意です。この識別子はデータアクセスの範囲を制限します。メッセージとファイルは同じ user 値でクエリした場合のみ表示されます。

query · string · default: ""

処理対象の入力テキストです。これはレガシーパラメータであり、新しいアプリではクエリを inputs オブジェクト内で渡す必要があります。

response_mode · enum<string>

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

Available options: streaming, blocking

files · object[]

マルチモーダル理解用のファイルリストです。画像、ドキュメント、音声、動画を含みます。ローカルファイルを添付するには、まず ファイルをアップロード でアップロードし、返された id を upload_file_id として transfer_method: local_file で使用します。

Option 1

Option 2

Show child attributes

Response

200

application/json

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

• response_mode が blocking の場合、 application/json で CompletionResponse オブジェクトを返します。
• response_mode が streaming の場合、 text/event-stream で ChunkCompletionEvent オブジェクトのストリームを返します。

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

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

Show child attributes

created_at · integer<int64>

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