停止工作流任务

适用于：Workflow。

停止正在运行的工作流任务。仅在 streaming 模式下支持。

POST /workflows/tasks/{task_id}/stop

停止工作流任务

cURL

curl --request POST \
  --url https://{api_base_url}/workflows/tasks/{task_id}/stop \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": "user_workflow_123"
}
'

import requests

url = "https://{api_base_url}/workflows/tasks/{task_id}/stop"

payload = { "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({user: 'user_workflow_123'})
};

fetch('https://{api_base_url}/workflows/tasks/{task_id}/stop', 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/tasks/{task_id}/stop",
  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([
    '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/tasks/{task_id}/stop"

	payload := strings.NewReader("{\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/tasks/{task_id}/stop")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user\": \"user_workflow_123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/workflows/tasks/{task_id}/stop")

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  \"user\": \"user_workflow_123\"\n}"

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

200

success

{ "result": "success" }

Authorizations

Authorization · string · header · required

API Key 认证。对于所有 API 请求，请在 Authorization HTTP 头中包含您的 API Key，并加上 Bearer 前缀。示例：Authorization: Bearer {API_KEY}。强烈建议将 API Key 存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。缺少或无效的 API Key 会返回 HTTP 401，错误码为 unauthorized。

Path Parameters

task_id · string · required

任务 ID，可以从 执行工作流 API 的流式分块返回中获取。

Body

application/json

user · string · required

用户标识符，仅用于标识请求的终端用户，无需与 执行工作流 请求传入的 user 一致；停止对该任务始终生效。

Response

200

application/json

操作成功。

result · string

操作结果，固定为 success。