跳转到内容
Agent as a BusinessAgent as a Business Documentation

运行 Workflow

POST
/api/app/{app_slug}/workflows/run
curl --request POST \
  --url https://api.agentaab.com/api/app/example/workflows/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "inputs": {} }'

使用一个 Object 类型的 inputs Payload 运行准确的当前激活 Workflow Capability Release。原生 Workflow 会在响应 Metadata 中返回脱敏执行 Trace。

授权

Section titled “授权”

参数

Section titled “参数”

路径参数

Section titled “Path 参数”
app_slug
必填
string

请求体必填

Section titled “请求体必填”
媒体类型application/json

当前激活 Workflow Capability Release 的公开请求。

object
inputs
必填
object
key
附加属性
any
示例生成
{
  "inputs": {}
}

响应

Section titled “响应”

200

Section titled “200”

Workflow 执行完成。

媒体类型application/json

归一化 Workflow 结果。原生 DAG 执行还会包含执行身份和脱敏 Trace。

object
id
必填
string format: uuid
answer
必填
string
provider
string
structured_result
object
key
附加属性
any
execution_id
string
created_at
必填
string format: date-time
metadata
必填
object
usage
必填
object
key
附加属性
any
execution_id
string
trace
Array<object>
object
node_id
必填
string
type
必填
string
允许的值： input agent tool condition transform output
status
必填
string
允许的值： completed skipped failed
started_at
必填
string format: date-time
finished_at
必填
string format: date-time
duration_ms
必填
integer
selected_branch
string
允许的值： true false
input_summary
output_summary
示例
{
  "metadata": {
    "trace": [
      {
        "type": "input",
        "status": "completed",
        "selected_branch": "true"
      }
    ]
  }
}

400

Section titled “400”

Workflow 请求正文无效。

媒体类型application/json

公开安全的运行时失败。字段会根据策略和执行阶段变化。

object
error
必填
string
code
string
execution_id
string
node_id
string
trace
Array<object>
object
node_id
必填
string
type
必填
string
允许的值： input agent tool condition transform output
status
必填
string
允许的值： completed skipped failed
started_at
必填
string format: date-time
finished_at
必填
string format: date-time
duration_ms
必填
integer
selected_branch
string
允许的值： true false
input_summary
output_summary
示例
{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

401

Section titled “401”

缺少公开运行时 Token，或 Token 无效。

媒体类型application/json

公开安全的运行时失败。字段会根据策略和执行阶段变化。

object
error
必填
string
code
string
execution_id
string
node_id
string
trace
Array<object>
object
node_id
必填
string
type
必填
string
允许的值： input agent tool condition transform output
status
必填
string
允许的值： completed skipped failed
started_at
必填
string format: date-time
finished_at
必填
string format: date-time
duration_ms
必填
integer
selected_branch
string
允许的值： true false
input_summary
output_summary
示例
{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

402

Section titled “402”

执行前需要运行时额度、积分或支付。

媒体类型application/json

公开安全的运行时失败。字段会根据策略和执行阶段变化。

object
error
必填
string
code
string
execution_id
string
node_id
string
trace
Array<object>
object
node_id
必填
string
type
必填
string
允许的值： input agent tool condition transform output
status
必填
string
允许的值： completed skipped failed
started_at
必填
string format: date-time
finished_at
必填
string format: date-time
duration_ms
必填
integer
selected_branch
string
允许的值： true false
input_summary
output_summary
示例
{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

403

Section titled “403”

运行时可见性、来源、授权或保护策略拒绝请求。

媒体类型application/json

公开安全的运行时失败。字段会根据策略和执行阶段变化。

object
error
必填
string
code
string
execution_id
string
node_id
string
trace
Array<object>
object
node_id
必填
string
type
必填
string
允许的值： input agent tool condition transform output
status
必填
string
允许的值： completed skipped failed
started_at
必填
string format: date-time
finished_at
必填
string format: date-time
duration_ms
必填
integer
selected_branch
string
允许的值： true false
input_summary
output_summary
示例
{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

409

Section titled “409”

幂等键或支付 Receipt 不能重复使用。

媒体类型application/json

公开安全的运行时失败。字段会根据策略和执行阶段变化。

object
error
必填
string
code
string
execution_id
string
node_id
string
trace
Array<object>
object
node_id
必填
string
type
必填
string
允许的值： input agent tool condition transform output
status
必填
string
允许的值： completed skipped failed
started_at
必填
string format: date-time
finished_at
必填
string format: date-time
duration_ms
必填
integer
selected_branch
string
允许的值： true false
input_summary
output_summary
示例
{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

413

Section titled “413”

有界 Workflow 请求正文过大。

媒体类型application/json

公开安全的运行时失败。字段会根据策略和执行阶段变化。

object
error
必填
string
code
string
execution_id
string
node_id
string
trace
Array<object>
object
node_id
必填
string
type
必填
string
允许的值： input agent tool condition transform output
status
必填
string
允许的值： completed skipped failed
started_at
必填
string format: date-time
finished_at
必填
string format: date-time
duration_ms
必填
integer
selected_branch
string
允许的值： true false
input_summary
output_summary
示例
{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

422

Section titled “422”

Workflow 节点执行失败；响应可能返回脱敏的部分 Trace。

媒体类型application/json

公开安全的运行时失败。字段会根据策略和执行阶段变化。

object
error
必填
string
code
string
execution_id
string
node_id
string
trace
Array<object>
object
node_id
必填
string
type
必填
string
允许的值： input agent tool condition transform output
status
必填
string
允许的值： completed skipped failed
started_at
必填
string format: date-time
finished_at
必填
string format: date-time
duration_ms
必填
integer
selected_branch
string
允许的值： true false
input_summary
output_summary
示例
{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

429

Section titled “429”

运行时速率或使用策略拒绝请求。

媒体类型application/json

公开安全的运行时失败。字段会根据策略和执行阶段变化。

object
error
必填
string
code
string
execution_id
string
node_id
string
trace
Array<object>
object
node_id
必填
string
type
必填
string
允许的值： input agent tool condition transform output
status
必填
string
允许的值： completed skipped failed
started_at
必填
string format: date-time
finished_at
必填
string format: date-time
duration_ms
必填
integer
selected_branch
string
允许的值： true false
input_summary
output_summary
示例
{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

503

Section titled “503”

无法证明准确的当前激活 Capability Release 权威状态。

媒体类型application/json

公开安全的运行时失败。字段会根据策略和执行阶段变化。

object
error
必填
string
code
string
execution_id
string
node_id
string
trace
Array<object>
object
node_id
必填
string
type
必填
string
允许的值： input agent tool condition transform output
status
必填
string
允许的值： completed skipped failed
started_at
必填
string format: date-time
finished_at
必填
string format: date-time
duration_ms
必填
integer
selected_branch
string
允许的值： true false
input_summary
output_summary
示例
{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}