sse模式执行 workflow - 联犀-企业版

请求参数

Header 参数

Ithings-Project-Id

string

可选

默认值:

Ithings-Token

string

可选

默认值:

app-code

string

可选

默认值:

device-id

string

可选

用户正在使用的设备ID(小程序,ios,安卓的设备ID)

Body 参数application/json

appCode

string

执行的应用

必需

inputs

object

可选

user

string

必需

用户标识，用于定义终端用户的身份，方便检索、统计。由开发者定义规则，需保证用户标识在应用内唯一。

示例

{
  "appCode": "string",
  "inputs": {},
  "user": "string"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v1/ai/app/sse/workflow-run' \
--header 'Ithings-Project-Id: {{Ithings-Project-Id}}' \
--header 'Ithings-Token: {{iThings-token}}' \
--header 'app-code: {{appCode}}' \
--header 'device-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appCode": "string",
    "inputs": {},
    "user": "string"
}'

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

data

object (AiAppWorkflowRunResp)

可选

event

string

必需

workflow_started workflow 开始执行 node_started node 开始执行 node_finished node 执行结束，成功失败同一事件中不同状态 workflow_finished workflow 执行结束，成功失败同一事件中不同状态

workflowRunID

string

必需

taskID

string

必需

workflowID

string

必需

status

string

必需

执行状态 running / succeeded / failed / stopped

outputs

object

必需

error

string

错误原因

可选

elapsedTime

number <double>

必需

Optional 耗时(s)

createdAt

integer <int32>

开始时间

必需

finishedAt

integer <int32>

结束时间

必需

inputs

object

必需

示例

{
  "code": "200",
  "msg": "string",
  "data": {
    "event": "string",
    "workflowRunID": "string",
    "taskID": "string",
    "workflowID": "string",
    "status": "string",
    "outputs": {},
    "error": "string",
    "elapsedTime": 0,
    "createdAt": 0,
    "finishedAt": 0,
    "inputs": {}
  }
}