完了メッセージを送信
対象アプリ：テキストジェネレーター。
テキスト生成アプリにリクエストを送信し、生成されたテキストを返します。
curl --request POST \
--url https://{api_base_url}/completion-messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": {
"city": "New York"
},
"query": "Summarize the following text: ...",
"response_mode": "blocking",
"user": "def-456"
}
'{
"answer": "Hello World!...",
"created_at": 1705407629,
"event": "message",
"id": "b01a39de-3480-4f3e-9f1e-4841a80f8e5e",
"message_id": "9da23599-e713-473b-982c-4328d4f5c78a",
"metadata": {
"usage": {
"completion_price": "0.0002560",
"completion_price_unit": "0.001",
"completion_tokens": 128,
"completion_unit_price": "0.002",
"currency": "USD",
"latency": 0.7682376249867957,
"prompt_price": "0.0010330",
"prompt_price_unit": "0.001",
"prompt_tokens": 1033,
"prompt_unit_price": "0.001",
"total_price": "0.0012890",
"total_tokens": 1161
}
},
"mode": "completion",
"task_id": "c3800678-a077-43df-a102-53f23ed20b88"
}Authorizations
すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。
Body
テキスト生成メッセージを作成するためのリクエストボディ。
アプリの入力変数の値を、変数名をキーとして指定します。期待される名前と型は、アプリケーションのパラメータ情報を取得 の user_input_form フィールドで確認できます。
エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。メッセージとファイルは、同じ user を持つリクエストにのみ表示されます。エンドユーザーの識別 を参照してください。
リクエストに添付するファイルです。ローカルファイルの場合は、まず ファイルをアップロード でアップロードし、返された id を upload_file_id として transfer_method: local_file で参照します。
- Option 1
- Option 2
Show child attributes
Show child attributes
処理するテキストです。レガシーフィールドで、新しいアプリではこの値を inputs の中で渡します。
レスポンスの返却モード。streaming（推奨）は SSE を使用します。blocking は完了後に返却します（長時間の処理では中断される場合があります）。Cloudflare のタイムアウトは 100 s です。省略した場合、デフォルトでブロッキングモードになります。
streaming, blocking Response
リクエスト成功。コンテンツタイプと構造はリクエストの response_mode パラメータに依存します。
response_modeがblockingの場合、application/jsonでCompletionResponseオブジェクトを返します。response_modeがstreamingの場合、text/event-streamでChunkCompletionEventオブジェクトのストリームを返します。
完全なレスポンスコンテンツ。
メッセージ作成タイムスタンプ（Unix エポック秒）。
イベントタイプ。message に固定されています。
このレスポンスイベントの一意 ID です。
一意のメッセージ ID です。フィードバックや推奨質問のエンドポイントを呼び出す際に message_id パラメータとして使用します。
使用量と検索リソースを含むメタデータ。
Show child attributes
Show child attributes
アプリモード、completion 固定です。
Was this page helpful?
curl --request POST \
--url https://{api_base_url}/completion-messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": {
"city": "New York"
},
"query": "Summarize the following text: ...",
"response_mode": "blocking",
"user": "def-456"
}
'{
"answer": "Hello World!...",
"created_at": 1705407629,
"event": "message",
"id": "b01a39de-3480-4f3e-9f1e-4841a80f8e5e",
"message_id": "9da23599-e713-473b-982c-4328d4f5c78a",
"metadata": {
"usage": {
"completion_price": "0.0002560",
"completion_price_unit": "0.001",
"completion_tokens": 128,
"completion_unit_price": "0.002",
"currency": "USD",
"latency": 0.7682376249867957,
"prompt_price": "0.0010330",
"prompt_price_unit": "0.001",
"prompt_tokens": 1033,
"prompt_unit_price": "0.001",
"total_price": "0.0012890",
"total_tokens": 1161
}
},
"mode": "completion",
"task_id": "c3800678-a077-43df-a102-53f23ed20b88"
}