ワークフローを実行
対象アプリ:Workflow。
アプリの公開済みワークフローを実行し、その出力を返します。単一の blocking レスポンス、または streaming の Server-Sent Events フィードのいずれかで返します。公開済みのワークフローが必要です。
curl -N --request POST \
--url 'https://{api_base_url}/workflows/run' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data '{"inputs": {"query": "Summarize this text: The quick brown fox jumps over the lazy dog."}, "response_mode": "streaming", "user": "{user}"}'import requests
url = "https://{api_base_url}/workflows/run"
payload = {
"inputs": { "query": "Summarize this text: The quick brown fox jumps over the lazy dog." },
"response_mode": "streaming",
"user": "user_workflow_123"
}
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: {query: 'Summarize this text: The quick brown fox jumps over the lazy dog.'},
response_mode: 'streaming',
user: 'user_workflow_123'
})
};
fetch('https://{api_base_url}/workflows/run', 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}/workflows/run",
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' => [
'query' => 'Summarize this text: The quick brown fox jumps over the lazy dog.'
],
'response_mode' => 'streaming',
'user' => 'user_workflow_123'
]),
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}/workflows/run"
payload := strings.NewReader("{\n \"inputs\": {\n \"query\": \"Summarize this text: The quick brown fox jumps over the lazy dog.\"\n },\n \"response_mode\": \"streaming\",\n \"user\": \"user_workflow_123\"\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}/workflows/run")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": {\n \"query\": \"Summarize this text: The quick brown fox jumps over the lazy dog.\"\n },\n \"response_mode\": \"streaming\",\n \"user\": \"user_workflow_123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/workflows/run")
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 \"query\": \"Summarize this text: The quick brown fox jumps over the lazy dog.\"\n },\n \"response_mode\": \"streaming\",\n \"user\": \"user_workflow_123\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。
Body
ワークフロー入力変数のキーと値のペアです。アプリが期待する変数名と型は、アプリケーションのパラメータ情報を取得 の user_input_form フィールドで確認できます。
ファイル型の変数には、type、transfer_method、および url または upload_file_id を持つファイルオブジェクトの配列を渡します。
Show child attributes
Show child attributes
エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。データアクセスをスコープします。ワークフロー実行とそのファイルは、同じ user を持つ後続のリクエストにのみ表示されます。エンドユーザーの識別 を参照してください。
レスポンスモードです。同期レスポンスには blocking(Cloudflare タイムアウトは 100 s)、サーバー送信イベントには streaming を使用します。省略した場合、デフォルトはブロッキング動作になります。
streaming, blocking ファイルリストです。ファイルとテキストを組み合わせて入力する場合に適しており、モデルが Vision 機能をサポートしている場合にのみ使用できます。ローカルファイルを添付するには、まず ファイルをアップロード でアップロードし、返された id を upload_file_id として transfer_method: local_file で使用します。
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
リクエスト成功。コンテンツタイプと構造はリクエストの response_mode パラメータに依存します。
response_modeがblockingの場合、application/jsonでWorkflowBlockingResponseオブジェクトを返します。response_modeがstreamingの場合、text/event-streamでChunkWorkflowEventオブジェクトのストリームを返します。
進行中の実行のタスク ID です。ワークフロータスクを停止 と組み合わせて、実行中のワークフローをキャンセルします。実行中のみ有効です。
このワークフロー実行記録の永続的な識別子です。ワークフロー実行詳細を取得 と組み合わせて、実行後に結果を取得します。
Show child attributes
Show child attributes
Was this page helpful?
curl -N --request POST \
--url 'https://{api_base_url}/workflows/run' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data '{"inputs": {"query": "Summarize this text: The quick brown fox jumps over the lazy dog."}, "response_mode": "streaming", "user": "{user}"}'import requests
url = "https://{api_base_url}/workflows/run"
payload = {
"inputs": { "query": "Summarize this text: The quick brown fox jumps over the lazy dog." },
"response_mode": "streaming",
"user": "user_workflow_123"
}
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: {query: 'Summarize this text: The quick brown fox jumps over the lazy dog.'},
response_mode: 'streaming',
user: 'user_workflow_123'
})
};
fetch('https://{api_base_url}/workflows/run', 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}/workflows/run",
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' => [
'query' => 'Summarize this text: The quick brown fox jumps over the lazy dog.'
],
'response_mode' => 'streaming',
'user' => 'user_workflow_123'
]),
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}/workflows/run"
payload := strings.NewReader("{\n \"inputs\": {\n \"query\": \"Summarize this text: The quick brown fox jumps over the lazy dog.\"\n },\n \"response_mode\": \"streaming\",\n \"user\": \"user_workflow_123\"\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}/workflows/run")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": {\n \"query\": \"Summarize this text: The quick brown fox jumps over the lazy dog.\"\n },\n \"response_mode\": \"streaming\",\n \"user\": \"user_workflow_123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/workflows/run")
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 \"query\": \"Summarize this text: The quick brown fox jumps over the lazy dog.\"\n },\n \"response_mode\": \"streaming\",\n \"user\": \"user_workflow_123\"\n}"
response = http.request(request)
puts response.read_body