InvokeAction - 运行执行动作

更新时间:
复制为 MD 格式

运行连接器的执行动作

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ConnectorId

string

连接器 ID

connector-xxx

ConnectorVersion

string

连接器版本

1

ActionId

string

执行动作 ID

action-xxx

ActionVersion

string

执行动作版本

1

Body

object

执行动作调用请求体参数

any

执行动作运行请求体内容,均采用 JSON 格式。

{ "model": "openclaw", "input": "hello" "user": "test-user" }

Headers

object

执行动作调用请求头参数

string

请求头参数

{"X-Request-User":"test"}

Query

object

执行动作调用查询参数

string

查询参数

{"count":3}

Path

object

执行动作调用路径参数

string

路径参数

{"version":1}

AuthConfig

object

执行动作调用鉴权信息

Type

string

鉴权信息类型

枚举值:

  • raw :

    鉴权内容原文,JSON 格式

  • id :

    AppFlow 鉴权凭证 ID

raw

Value

any

鉴权内容

{"AppId":"xxxx","AppSecret":"sk-xxx"}

Stream

boolean

是否采用流式输出

false

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

346E5EE9-D5FE-56A0-B3E2-A43E0F67302A

Result

object

返回结果

Status

string

运行状态

RUNNING、COMPLETED

ErrorMessage

string

错误信息

The provided parameter xxx is invalid.

Output

any

执行动作输出

{ "output": { "finishReason": "stop", "text": "hello" }, "requestId": "433944e3-2163-9c7a-9664-2a27c0dda0ec", "usage": { "inputTokens": 13, "outputTokens": 16, "totalTokens": 29 } }

示例

正常返回示例

JSON格式

{
  "RequestId": "346E5EE9-D5FE-56A0-B3E2-A43E0F67302A",
  "Result": {
    "Status": "RUNNING、COMPLETED",
    "ErrorMessage": "The provided parameter xxx is invalid.",
    "Output": "{\n  \"output\": {\n    \"finishReason\": \"stop\",\n    \"text\": \"hello\"\n  },\n  \"requestId\": \"433944e3-2163-9c7a-9664-2a27c0dda0ec\",\n  \"usage\": {\n    \"inputTokens\": 13,\n    \"outputTokens\": 16,\n    \"totalTokens\": 29\n  }\n}"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情