ID でワークフローを実行

ID でワークフローを実行

curl --request POST \
  --url https://{api_base_url}/workflows/{workflow_id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": {
    "query": "Summarize this article"
  },
  "response_mode": "blocking",
  "user": "user_workflow_123"
}
'

import requests

url = "https://{api_base_url}/workflows/{workflow_id}/run"

payload = {
    "inputs": { "query": "Summarize this article" },
    "response_mode": "blocking",
    "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 article'},
    response_mode: 'blocking',
    user: 'user_workflow_123'
  })
};

fetch('https://{api_base_url}/workflows/{workflow_id}/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/{workflow_id}/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 article'
    ],
    'response_mode' => 'blocking',
    '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/{workflow_id}/run"

	payload := strings.NewReader("{\n  \"inputs\": {\n    \"query\": \"Summarize this article\"\n  },\n  \"response_mode\": \"blocking\",\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/{workflow_id}/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"inputs\": {\n    \"query\": \"Summarize this article\"\n  },\n  \"response_mode\": \"blocking\",\n  \"user\": \"user_workflow_123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/workflows/{workflow_id}/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 article\"\n  },\n  \"response_mode\": \"blocking\",\n  \"user\": \"user_workflow_123\"\n}"

response = http.request(request)
puts response.read_body

{
  "task_id": "c3800678-a077-43df-a102-53f23ed20b88",
  "workflow_run_id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
  "data": {
    "id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
    "workflow_id": "7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345",
    "status": "succeeded",
    "outputs": {
      "result": "Article summary here"
    },
    "error": null,
    "elapsed_time": 2.45,
    "total_tokens": 280,
    "total_steps": 4,
    "created_at": 1705407629,
    "finished_at": 1705407631
  }
}

POST

workflows

{workflow_id}

run

ID でワークフローを実行

curl --request POST \
  --url https://{api_base_url}/workflows/{workflow_id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": {
    "query": "Summarize this article"
  },
  "response_mode": "blocking",
  "user": "user_workflow_123"
}
'

import requests

url = "https://{api_base_url}/workflows/{workflow_id}/run"

payload = {
    "inputs": { "query": "Summarize this article" },
    "response_mode": "blocking",
    "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 article'},
    response_mode: 'blocking',
    user: 'user_workflow_123'
  })
};

fetch('https://{api_base_url}/workflows/{workflow_id}/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/{workflow_id}/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 article'
    ],
    'response_mode' => 'blocking',
    '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/{workflow_id}/run"

	payload := strings.NewReader("{\n  \"inputs\": {\n    \"query\": \"Summarize this article\"\n  },\n  \"response_mode\": \"blocking\",\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/{workflow_id}/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"inputs\": {\n    \"query\": \"Summarize this article\"\n  },\n  \"response_mode\": \"blocking\",\n  \"user\": \"user_workflow_123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/workflows/{workflow_id}/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 article\"\n  },\n  \"response_mode\": \"blocking\",\n  \"user\": \"user_workflow_123\"\n}"

response = http.request(request)
puts response.read_body

{
  "task_id": "c3800678-a077-43df-a102-53f23ed20b88",
  "workflow_run_id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
  "data": {
    "id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
    "workflow_id": "7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345",
    "status": "succeeded",
    "outputs": {
      "result": "Article summary here"
    },
    "error": null,
    "elapsed_time": 2.45,
    "total_tokens": 280,
    "total_steps": 4,
    "created_at": 1705407629,
    "finished_at": 1705407631
  }
}

承認

Authorization

string

header

必須

すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。

パスパラメータ

workflow_id

string

必須

実行する公開済みワークフローバージョンです。ワークフローを実行のレスポンスおよびワークフロー実行詳細を取得の workflow_id フィールドで返されます。公開済みバージョンを指定する必要があります。ドラフトバージョンの ID は bad_request で拒否されます。

ボディ

application/json

inputs

object

必須

ワークフロー入力変数のキーと値のペアです。アプリが期待する変数名と型は、アプリケーションのパラメータ情報を取得の user_input_form フィールドで確認できます。

ファイル型の変数には、type、transfer_method、および url または upload_file_id を持つファイルオブジェクトの配列を渡します。

Show child attributes

user

string

必須

エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。データアクセスをスコープします。ワークフロー実行とそのファイルは、同じ user を持つ後続のリクエストにのみ表示されます。エンドユーザーの識別を参照してください。

response_mode

enum<string>

レスポンスモードです。省略時は blocking になります。

streaming：サーバー送信イベント（SSE）でレスポンスを返します。
blocking：イベントストリームではなく、1 つの JSON レスポンスを返します。

実行に時間がかかる場合は streaming を使用してください。blocking を使う場合は、リバースプロキシやゲートウェイのタイムアウトを最長の実行時間より長く設定してください。

利用可能なオプション:

streaming,

blocking

files

object[] | null

ファイルリストです。ファイルとテキストを組み合わせて入力する場合に適しており、モデルが Vision 機能をサポートしている場合にのみ使用できます。ローカルファイルを添付するには、まずファイルをアップロードでアップロードし、返された id を upload_file_id として transfer_method: local_file で使用します。

Option 1
Option 2

Show child attributes

レスポンス

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

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

task_id

string<uuid>

進行中の実行のタスク ID です。ワークフロータスクを停止と組み合わせて、実行中のワークフローをキャンセルします。実行中のみ有効です。

workflow_run_id

string<uuid>

このワークフロー実行記録の永続的な識別子です。ワークフロー実行詳細を取得と組み合わせて、実行後に結果を取得します。

data

object

Show child attributes

ガイド

アプリ API

ナレッジ API

承認

パスパラメータ

ボディ

レスポンス