### リクエストボディ

<Properties>

  <Property name='inputs' type='object' key='inputs'>
      アプリで定義された各種変数値を入力できます。
      `inputs`パラメータには複数のキー/値ペアが含まれ、各キーは特定の変数に対応し、各値はその変数の具体的な値となります。
      テキスト生成アプリケーションでは、少なくとも1つのキー/値ペアの入力が必要です。
      - `query` (string) 必須
        入力テキスト、処理される内容。
  </Property>
  <Property name='response_mode' type='string' key='response_mode'>
    レスポンス返却モード、以下をサポート：
    - `streaming` ストリーミングモード（推奨）、SSE（[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)）によるタイプライター風の出力を実装。
    - `blocking` ブロッキングモード、実行完了後に結果を返却。（処理が長い場合はリクエストが中断される可能性があります）
    <i>Cloudflareの制限により、100秒後に返却なしで中断されます。</i>
  </Property>
  <Property name='user' type='string' key='user'>
      ユーザー識別子、エンドユーザーの身元を定義し、取得や統計に使用します。
      アプリケーション内で開発者が一意に定義する必要があります。
  </Property>
  <Property name='files' type='array[object]' key='files'>
      ファイルリスト、モデルが Vision/Video 機能をサポートしている場合に限り、ファイルをテキスト理解および質問応答に組み合わせて入力するのに適しています。
      - `type` (string) サポートされるタイプ：
        - `document` サポートされるタイプには以下が含まれます：'TXT', 'MD', 'MARKDOWN', 'MDX', 'PDF', 'HTML', 'XLSX', 'XLS', 'VTT', 'PROPERTIES', 'DOC', 'DOCX', 'CSV', 'EML', 'MSG', 'PPTX', 'PPT', 'XML', 'EPUB'
        - `image` サポートされるタイプには以下が含まれます：'JPG', 'JPEG', 'PNG', 'GIF', 'WEBP', 'SVG'
        - `audio` サポートされるタイプには以下が含まれます：'MP3', 'M4A', 'WAV', 'WEBM', 'MPGA'
        - `video` サポートされるタイプには以下が含まれます：'MP4', 'MOV', 'MPEG', 'WEBM'
        - `custom` サポートされるタイプには以下が含まれます：その他のファイルタイプ
      - `transfer_method` (string) 転送方法:
        - `remote_url`: ファイルのURL。
        - `local_file`: ファイルをアップロード。
      - `url` ファイルのURL。（転送方法が `remote_url` の場合のみ）。
      - `upload_file_id` アップロードされたファイルID。（転送方法が `local_file` の場合のみ）。
  </Property>
</Properties>

### レスポンス
`response_mode`が`blocking`の場合、CompletionResponseオブジェクトを返却します。
`response_mode`が`streaming`の場合、ChunkCompletionResponseストリームを返却します。

### ChatCompletionResponse
アプリの完全な結果を返却、`Content-Type`は`application/json`です。
- `message_id` (string) 一意のメッセージID
- `mode` (string) アプリモード、固定で`chat`
- `answer` (string) 完全な応答内容
- `metadata` (object) メタデータ
  - `usage` (Usage) モデル使用情報
  - `retriever_resources` (array[RetrieverResource]) 引用と帰属のリスト
- `created_at` (int) メッセージ作成タイムスタンプ、例：1705395332

### ChunkChatCompletionResponse
アプリが出力するストリームチャンクを返却、`Content-Type`は`text/event-stream`です。
各ストリーミングチャンクは`data:`で始まり、2つの改行文字`\n\n`で区切られます：
<CodeGroup>
```streaming {{ title: 'Response' }}
data: {"event": "message", "task_id": "900bbd43-dc0b-4383-a372-aa6e6c414227", "id": "663c5084-a254-4040-8ad3-51f2a3c1a77c", "answer": "Hi", "created_at": 1705398420}\n\n
```
</CodeGroup>
ストリーミングチャンクの構造は`event`によって異なります：
- `event: message` LLMがテキストチャンクを返すイベント、つまり完全なテキストがチャンク形式で出力されます。
  - `task_id` (string) タスクID、リクエストの追跡と以下の生成停止APIに使用
  - `message_id` (string) 一意のメッセージID
  - `answer` (string) LLMが返したテキストチャンクの内容
  - `created_at` (int) 作成タイムスタンプ、例：1705395332
- `event: message_end` メッセージ終了イベント、このイベントを受信するとストリーミングが終了したことを意味します。
  - `task_id` (string) タスクID、リクエストの追跡と以下の生成停止APIに使用
  - `message_id` (string) 一意のメッセージID
  - `metadata` (object) メタデータ
    - `usage` (Usage) モデル使用情報
    - `retriever_resources` (array[RetrieverResource]) 引用と帰属のリスト
- `event: tts_message` TTS音声ストリームイベント、つまり音声合成出力。内容はMp3形式の音声ブロックで、base64文字列としてエンコードされています。再生時は単にbase64をデコードしてプレーヤーに供給するだけです。（このメッセージは自動再生が有効な場合のみ利用可能）
  - `task_id` (string) タスクID、リクエストの追跡と以下の応答停止インターフェースに使用
  - `message_id` (string) 一意のメッセージID
  - `audio` (string) 音声合成後の音声、base64テキストコンテンツとしてエンコード、再生時は単にbase64をデコードしてプレーヤーに供給
  - `created_at` (int) 作成タイムスタンプ、例：1705395332
- `event: tts_message_end` TTS音声ストリーム終了イベント、このイベントを受信すると音声ストリームが終了したことを示します。
  - `task_id` (string) タスクID、リクエストの追跡と以下の応答停止インターフェースに使用
  - `message_id` (string) 一意のメッセージID
  - `audio` (string) 終了イベントには音声がないため、空文字列
  - `created_at` (int) 作成タイムスタンプ、例：1705395332
- `event: message_replace` メッセージ内容置換イベント。
  出力内容のモデレーションが有効な場合、コンテンツがフラグ付けされると、このイベントを通じてメッセージ内容が事前設定された返信に置き換えられます。
  - `task_id` (string) タスクID、リクエストの追跡と以下の生成停止APIに使用
  - `message_id` (string) 一意のメッセージID
  - `answer` (string) 置換内容（LLMの返信テキストすべてを直接置換）
  - `created_at` (int) 作成タイムスタンプ、例：1705395332
- `event: error`
  ストリーミング処理中に発生した例外は、ストリームイベントの形式で出力され、エラーイベントを受信するとストリームが終了します。
  - `task_id` (string) タスクID、リクエストの追跡と以下の生成停止APIに使用
  - `message_id` (string) 一意のメッセージID
  - `status` (int) HTTPステータスコード
  - `code` (string) エラーコード
  - `message` (string) エラーメッセージ
- `event: ping` 接続を維持するため10秒ごとのPingイベント。

### エラー
- 404, 会話が存在しません
- 400, `invalid_param`, パラメータ入力異常
- 400, `app_unavailable`, アプリ設定が利用できません
- 400, `provider_not_initialize`, 利用可能なモデル認証情報設定がありません
- 400, `provider_quota_exceeded`, モデル呼び出しクォータ不足
- 400, `model_currently_not_support`, 現在のモデルは利用できません
- 400, `completion_request_error`, テキスト生成に失敗しました
- 500, 内部サーバーエラー

<CodeGroup
  title="Request"
  tag="POST"
  label="/completion-messages"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/completion-messages' \\

他の API がエンドユーザー ID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。

### パスパラメータ
- `end_user_id` (uuid) 必須
  エンドユーザー ID。

### レスポンス
EndUser オブジェクトを返します。
- `id` (uuid) ID
- `tenant_id` (uuid) テナント ID
- `app_id` (uuid) アプリ ID
- `type` (string) エンドユーザー種別
- `external_user_id` (string) 外部ユーザー ID
- `name` (string) 名前
- `is_anonymous` (boolean) 匿名ユーザーかどうか
- `session_id` (string) セッション ID
- `created_at` (string) ISO 8601 日時
- `updated_at` (string) ISO 8601 日時

### エラー
- 404, `end_user_not_found`, エンドユーザーが見つかりません
- 500, 内部サーバーエラー

### レスポンス例
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "id": "6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13",
  "tenant_id": "8c0f3f3a-66b0-4b55-a0bf-8b8e0d6aee7d",
  "app_id": "6c8c3f41-2c6f-4e1b-8f4f-7f11c8f2ad2a",
  "type": "service_api",
  "external_user_id": "abc-123",
  "name": "Alice",
  "is_anonymous": false,
  "session_id": "abc-123",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}
```
</CodeGroup>

<i>ファイルは、リクエストしているアプリケーションのメッセージ範囲内にある場合のみアクセス可能です。</i>

### パスパラメータ
- `file_id` (string) 必須
  プレビューするファイルの一意識別子。ファイルアップロード API レスポンスから取得します。

### クエリパラメータ
- `as_attachment` (boolean) オプション
  ファイルを添付ファイルとして強制ダウンロードするかどうか。デフォルトは `false`（ブラウザでプレビュー）。

### レスポンス
ブラウザ表示またはダウンロード用の適切なヘッダー付きでファイル内容を返します。
- `Content-Type` ファイル MIME タイプに基づいて設定
- `Content-Length` ファイルサイズ（バイト、利用可能な場合）
- `Content-Disposition` `as_attachment=true` の場合は "attachment" に設定
- `Cache-Control` パフォーマンス向上のためのキャッシュヘッダー
- `Accept-Ranges` 音声/動画ファイルの場合は "bytes" に設定

### エラー
- 400, `invalid_param`, パラメータ入力異常
- 403, `file_access_denied`, ファイルアクセス拒否またはファイルが現在のアプリケーションに属していません
- 404, `file_not_found`, ファイルが見つからないか削除されています
- 500, サーバー内部エラー

### 添付ファイルとしてダウンロード
<CodeGroup
  title="Request"
  tag="GET"
  label="/files/:file_id/preview"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/files/72fa9618-8f89-4a37-9b33-7e1178a24a67/preview?as_attachment=true' \\

### レスポンスヘッダー例
<CodeGroup title="Response Headers">
```http {{ title: 'ヘッダー - 画像プレビュー' }}
Content-Type: image/png
Content-Length: 1024
Cache-Control: public, max-age=3600
```
</CodeGroup>

### ファイルダウンロードレスポンスヘッダー
<CodeGroup title="Response Headers">
```http {{ title: 'ヘッダー - ファイルダウンロード' }}
Content-Type: image/png
Content-Length: 1024
Content-Disposition: attachment; filename*=UTF-8''example.png
Cache-Control: public, max-age=3600
```
</CodeGroup>

### レスポンス例
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "result": "success"
}
```
</CodeGroup>

### パス
<Properties>
  <Property name='message_id' type='string' key='message_id'>
   メッセージID
  </Property>
</Properties>

### リクエストボディ

<Properties>
  <Property name='rating' type='string' key='rating'>
    高評価は`like`、低評価は`dislike`、高評価の取り消しは`null`
  </Property>
  <Property name='user' type='string' key='user'>
    開発者のルールで定義されたユーザー識別子。アプリケーション内で一意である必要があります。
  </Property>
  <Property name='content' type='string' key='content'>
    メッセージのフィードバックです。
  </Property>
</Properties>

### レスポンス
- `result` (string) 常に"success"を返します

<CodeGroup
  title="Request"
  tag="POST"
  label="/messages/:message_id/feedbacks"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/messages/:message_id/feedbacks \\

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "result": "success"
}
```
</CodeGroup>

### クエリ
<Properties>
  <Property name='page' type='string' key='page'>
   （任意）ページ番号。デフォルト値：1
  </Property>
</Properties>

<Properties>
  <Property name='limit' type='string' key='limit'>
   （任意）1ページあたりの件数。デフォルト値：20
  </Property>
</Properties>

### レスポンス
- `data` (リスト) このアプリの「いいね」とフィードバックの一覧を返します。

<CodeGroup
  title="Request"
  tag="GET"
  label="/app/feedbacks"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/app/feedbacks?page=1&limit=20'`}
/>

<CodeGroup title="Response">
```json {{ title: 'Response' }}
    {
    "data": [
        {
            "id": "8c0fbed8-e2f9-49ff-9f0e-15a35bdd0e25",
            "app_id": "f252d396-fe48-450e-94ec-e184218e7346",
            "conversation_id": "2397604b-9deb-430e-b285-4726e51fd62d",
            "message_id": "709c0b0f-0a96-4a4e-91a4-ec0889937b11",
            "rating": "like",
            "content": "message feedback information-3",
            "from_source": "user",
            "from_end_user_id": "74286412-9a1a-42c1-929c-01edb1d381d5",
            "from_account_id": null,
            "created_at": "2025-04-24T09:24:38",
            "updated_at": "2025-04-24T09:24:38"
        }
    ]
    }
```
</CodeGroup>

### リクエストボディ

<Properties>
  <Property name='message_id' type='str' key='message_id'>
    Difyが生成したテキストメッセージの場合、生成されたmessage-idを直接渡すだけです。バックエンドはmessage-idを使用して対応するコンテンツを検索し、音声情報を直接合成します。message_idとtextの両方が同時に提供された場合、message_idが優先されます。
  </Property>
  <Property name='text' type='str' key='text'>
    音声生成コンテンツ。
  </Property>
  <Property name='user' type='string' key='user'>
    開発者が定義したユーザー識別子。アプリ内で一意性を確保する必要があります。
  </Property>
</Properties>

<CodeGroup
  title="Request"
  tag="POST"
  label="/text-to-audio"
  targetCode={`curl -o text-to-audio.mp3 -X POST '${props.appDetail.api_base_url}/text-to-audio' \\

<CodeGroup title="headers">
```json {{ title: 'headers' }}
{
  "Content-Type": "audio/wav"
}
```
</CodeGroup>

### レスポンス
- `opening_statement` (string) 開始文
- `suggested_questions` (array[string]) 開始時の提案質問リスト
- `suggested_questions_after_answer` (object) 回答後の提案質問を有効にします。
  - `enabled` (bool) 有効かどうか
- `speech_to_text` (object) 音声からテキスト
  - `enabled` (bool) 有効かどうか
- `retriever_resource` (object) 引用と帰属
  - `enabled` (bool) 有効かどうか
- `annotation_reply` (object) 注釈付き返信
  - `enabled` (bool) 有効かどうか
- `user_input_form` (array[object]) ユーザー入力フォーム設定
  - `text-input` (object) テキスト入力コントロール
    - `label` (string) 変数表示ラベル名
    - `variable` (string) 変数ID
    - `required` (bool) 必須かどうか
    - `default` (string) デフォルト値
  - `paragraph` (object) 段落テキスト入力コントロール
    - `label` (string) 変数表示ラベル名
    - `variable` (string) 変数ID
    - `required` (bool) 必須かどうか
    - `default` (string) デフォルト値
  - `select` (object) ドロップダウンコントロール
    - `label` (string) 変数表示ラベル名
    - `variable` (string) 変数ID
    - `required` (bool) 必須かどうか
    - `default` (string) デフォルト値
    - `options` (array[string]) オプション値
- `file_upload` (object) ファイルアップロード設定
  - `document` (object) ドキュメント設定
    現在サポートされているドキュメントタイプ：`txt`, `md`, `markdown`, `pdf`, `html`, `xlsx`, `xls`, `docx`, `csv`, `eml`, `msg`, `pptx`, `ppt`, `xml`, `epub`。
    - `enabled` (bool) 有効かどうか
    - `number_limits` (int) ドキュメント数の上限。デフォルトは 3
    - `transfer_methods` (array[string]) 転送方法リスト：`remote_url`, `local_file`。いずれかを選択する必要があります。
  - `image` (object) 画像設定
    現在サポートされている画像タイプ：`png`, `jpg`, `jpeg`, `webp`, `gif`。
    - `enabled` (bool) 有効かどうか
    - `number_limits` (int) 画像数の上限。デフォルトは 3
    - `transfer_methods` (array[string]) 転送方法リスト：`remote_url`, `local_file`。いずれかを選択する必要があります。
  - `audio` (object) オーディオ設定
    現在サポートされているオーディオタイプ：`mp3`, `m4a`, `wav`, `webm`, `amr`。
    - `enabled` (bool) 有効かどうか
    - `number_limits` (int) オーディオ数の上限。デフォルトは 3
    - `transfer_methods` (array[string]) 転送方法リスト：`remote_url`, `local_file`。いずれかを選択する必要があります。
  - `video` (object) ビデオ設定
    現在サポートされているビデオタイプ：`mp4`, `mov`, `mpeg`, `mpga`。
    - `enabled` (bool) 有効かどうか
    - `number_limits` (int) ビデオ数の上限。デフォルトは 3
    - `transfer_methods` (array[string]) 転送方法リスト：`remote_url`, `local_file`。いずれかを選択する必要があります。
  - `custom` (object) カスタム設定
    - `enabled` (bool) 有効かどうか
    - `number_limits` (int) カスタム数の上限。デフォルトは 3
    - `transfer_methods` (array[string]) 転送方法リスト：`remote_url`, `local_file`。いずれかを選択する必要があります。
- `system_parameters` (object) システムパラメータ
  - `file_size_limit` (int) ドキュメントアップロードサイズ制限（MB）
  - `image_file_size_limit` (int) 画像ファイルアップロードサイズ制限（MB）
  - `audio_file_size_limit` (int) 音声ファイルアップロードサイズ制限（MB）
  - `video_file_size_limit` (int) 動画ファイルアップロードサイズ制限（MB）

<CodeGroup
  title="Request"
  tag="GET"
  label="/parameters"
  targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'`}
/>

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "opening_statement": "Hello!",
  "suggested_questions_after_answer": {
      "enabled": true
  },
  "speech_to_text": {
      "enabled": true
  },
  "retriever_resource": {
      "enabled": true
  },
  "annotation_reply": {
      "enabled": true
  },
  "user_input_form": [
      {
          "paragraph": {
              "label": "Query",
              "variable": "query",
              "required": true,
              "default": ""
          }
      }
  ],
  "file_upload": {
      "image": {
          "enabled": false,
          "number_limits": 3,
          "detail": "high",
          "transfer_methods": [
              "remote_url",
              "local_file"
          ]
      }
  },
  "system_parameters": {
      "file_size_limit": 15,
      "image_file_size_limit": 10,
      "audio_file_size_limit": 50,
      "video_file_size_limit": 100
  }
}
```
</CodeGroup>

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "title": "My App",
  "chat_color_theme": "#ff4a4a",
  "chat_color_theme_inverted": false,
  "icon_type": "emoji",
  "icon": "😄",
  "icon_background": "#FFEAD5",
  "icon_url": null,
  "description": "This is my app.",
  "copyright": "all rights reserved",
  "privacy_policy": "",
  "custom_disclaimer": "All generated by AI",
  "default_language": "en-US",
  "show_workflow_steps": false,
  "use_icon_as_answer_icon": false,
}
```
</CodeGroup>