> ## Documentation Index
> Fetch the complete documentation index at: https://enterprise-docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# デプロイ環境

> デプロイ環境で動作するアプリの呼び出し方。専用のベース URL、認証、エラーを解説します

[デプロイ環境](/ja/3.13.x/use/deploy/overview) では、アプリは `v2` のベース URL で API を提供します。認証には、アプリと環境に紐づく API キーを使います。

## ベース URL

すべてのデプロイ環境は 1 つの `v2` ベース URL を共有します。標準の Service API アドレスで `/v1` を `/v2` に置き換えたものです。アプリの **アクセスポイント** タブにある、いずれかのデプロイ環境の **バックエンドサービス API** カードで確認できます。

## 認証

アプリの **アクセスポイント** タブにある環境のカードで API キーを生成し、Bearer トークンとして送信します。

```bash theme={null}
curl https://api.example.com/v2/workflows/run \
  -H "Authorization: Bearer $DIFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"inputs": {}, "response_mode": "blocking", "user": "user-123"}'
```

ベース URL はどの環境でも同じです。そのため、どのアプリのどの環境がリクエストを処理するかは、キーだけで決まります。`staging` を呼び出すには、`staging` 用に生成したキーを使います。

生成した API キーは、その環境からアプリをアンデプロイしても有効なままです。アンデプロイ中は呼び出しが失敗しますが、再びデプロイすれば同じキーがそのまま使えます。

## 対応するエンドポイント

デプロイ環境が提供するのは、次の操作だけです。このベース URL でそれ以外のパスを呼び出すと、`404 not_found` が返ります。

* Workflow アプリの場合：
  * [ワークフローを実行](/ja/3.13.x/develop/api/deployed-environments/run-workflow)
  * [ワークフロータスクを停止](/ja/3.13.x/develop/api/deployed-environments/stop-workflow-task)

* Chatflow アプリの場合：
  * [チャットメッセージを送信](/ja/3.13.x/develop/api/deployed-environments/send-chat-message)
  * [チャットメッセージの生成を停止](/ja/3.13.x/develop/api/deployed-environments/stop-chat-message-generation)
  * [会話一覧を取得](/ja/3.13.x/develop/api/deployed-environments/list-conversations)
  * [会話を削除](/ja/3.13.x/develop/api/deployed-environments/delete-conversation)
  * [会話の名前を変更](/ja/3.13.x/develop/api/deployed-environments/rename-conversation)
  * [会話履歴メッセージ一覧を取得](/ja/3.13.x/develop/api/deployed-environments/list-conversation-messages)
  * [会話変数一覧を取得](/ja/3.13.x/develop/api/deployed-environments/list-conversation-variables)
  * [会話変数を更新](/ja/3.13.x/develop/api/deployed-environments/update-conversation-variable)

* 両方のアプリタイプの場合：
  * [ファイルをアップロード](/ja/3.13.x/develop/api/deployed-environments/upload-file)
  * [ファイルをダウンロード](/ja/3.13.x/develop/api/deployed-environments/download-file)

## エラー

HTTP エラーレスポンスの例：

```json theme={null}
{
  "code": "deployment_not_ready",
  "message": "deployment is in progress",
  "status": 503
}
```

ストリーミングレスポンスの開始後は、エラーはストリーム内の `error` イベントとして返されます。形式は各 API のリファレンスを参照してください。

各操作のリファレンスページには、その操作が返すエラーコードがすべて記載されています。複数の操作に共通するケースは、次の 3 つです。

* 認証情報が無効な場合やデプロイを利用できない場合、実行系とアップロード系の操作は次のエラーでリクエストを拒否します。対象は、ワークフローの実行と停止、チャットの送信と停止、ファイルのアップロードです。

  | エラーコード | ステータス | 意味 |
  | :- | :- | :- |
  | `token_invalid` | 401 | API キーがない、形式が不正、または不明です。 |
  | `unauthorized` | 401 | API キーが取り消されています。 |
  | `forbidden` | 403 | **アクセスポイント** で、この環境の API アクセスが無効になっています。 |
  | `deployment_undeployed` | 503 | この環境からアプリがアンデプロイされています。提供を再開するにはバージョンをデプロイしてください。 |
  | `deployment_not_ready` | 503 | デプロイが進行中です。しばらくしてから再試行してください。 |
  | `apprunner_not_deployed` | 503 | 環境が利用できません。環境が削除中の場合や、稼働していない場合、接続できない場合などに発生します。プラットフォームの管理者に環境の確認を依頼してください。 |
  | `service_not_ready` | 503 | デプロイされたバージョンが、この環境でまだ提供できる状態になっていません。読み込み中や入れ替え中などに発生します。しばらくしてから再試行してください。 |
  | `enterprise_unavailable` | 503 | プラットフォーム側のルーティングサービスが一時的に利用できません。しばらくしてから再試行してください。 |

* 会話管理とファイルのダウンロードは、次のエラーを返します。

  * 無効なキーに対しては `401 unauthorized`。
  * アプリの API アクセスが無効な場合、またはこの環境でアプリがデプロイされ利用可能になっていない場合は `400 app_unavailable`。

* ワークフローの実行やチャットリクエストが、環境の最大実行時間（デフォルトは 20 分）を超えると、`request_timeout` で停止します。ブロッキングモードでは HTTP 504 が、ストリーミングモードでは `status: 504` を持つ `error` イベントが返ります。

  この上限を決める設定については、[デプロイ環境（App Runner）](/ja/3.13.x/deploy/advanced-configuration/environment-variables#app-runner) の `enterprise.workflowMaxExecutionTimeSeconds` を参照してください。