Run a Workflow

POST

/api/app/{app_slug}/workflows/run

const url = 'https://api.agentaab.com/api/app/example/workflows/run';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"inputs":{}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Run the exact active Workflow Capability Release with one object-valued inputs payload. Native Workflows return a sanitized execution trace in response metadata.

Authorizations

runtimeBearerAuth
runtimeApiKeyAuth

Parameters

Path Parameters

app_slug

required

string

Request Body^required

application/json

Public request for an active Workflow Capability Release.

object

inputs

required

object

key

additional properties

any

Example^generated

{
  "inputs": {}
}

Responses

200

Workflow execution completed.

application/json

Normalized Workflow result. Native DAG execution also includes an execution identity and sanitized trace.

object

required

string format: uuid

answer

required

string

provider

string

structured_result

object

key

additional properties

any

execution_id

string

created_at

required

string format: date-time

metadata

required

object

usage

required

object

key

additional properties

any

execution_id

string

trace

Array<object>

object

node_id

required

string

type

required

string

Allowed values: input agent tool condition transform output

status

required

string

Allowed values: completed skipped failed

started_at

required

string format: date-time

finished_at

required

string format: date-time

duration_ms

required

integer

selected_branch

string

Allowed values: true false

input_summary

output_summary

Example

{
  "metadata": {
    "trace": [
      {
        "type": "input",
        "status": "completed",
        "selected_branch": "true"
      }
    ]
  }
}

400

The Workflow request body is invalid.

application/json

Public-safe runtime failure. Fields vary by policy and execution phase.

object

error

required

string

code

string

execution_id

string

node_id

string

trace

Array<object>

object

node_id

required

string

type

required

string

Allowed values: input agent tool condition transform output

status

required

string

Allowed values: completed skipped failed

started_at

required

string format: date-time

finished_at

required

string format: date-time

duration_ms

required

integer

selected_branch

string

Allowed values: true false

input_summary

output_summary

Example

{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

401

The public runtime token is missing or invalid.

application/json

Public-safe runtime failure. Fields vary by policy and execution phase.

object

error

required

string

code

string

execution_id

string

node_id

string

trace

Array<object>

object

node_id

required

string

type

required

string

Allowed values: input agent tool condition transform output

status

required

string

Allowed values: completed skipped failed

started_at

required

string format: date-time

finished_at

required

string format: date-time

duration_ms

required

integer

selected_branch

string

Allowed values: true false

input_summary

output_summary

Example

{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

402

Runtime quota, credit, or payment is required before execution.

application/json

Public-safe runtime failure. Fields vary by policy and execution phase.

object

error

required

string

code

string

execution_id

string

node_id

string

trace

Array<object>

object

node_id

required

string

type

required

string

Allowed values: input agent tool condition transform output

status

required

string

Allowed values: completed skipped failed

started_at

required

string format: date-time

finished_at

required

string format: date-time

duration_ms

required

integer

selected_branch

string

Allowed values: true false

input_summary

output_summary

Example

{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

403

Runtime visibility, origin, authorization, or protection policy denied the request.

application/json

Public-safe runtime failure. Fields vary by policy and execution phase.

object

error

required

string

code

string

execution_id

string

node_id

string

trace

Array<object>

object

node_id

required

string

type

required

string

Allowed values: input agent tool condition transform output

status

required

string

Allowed values: completed skipped failed

started_at

required

string format: date-time

finished_at

required

string format: date-time

duration_ms

required

integer

selected_branch

string

Allowed values: true false

input_summary

output_summary

Example

{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

409

An idempotency key or payment receipt cannot be reused.

application/json

Public-safe runtime failure. Fields vary by policy and execution phase.

object

error

required

string

code

string

execution_id

string

node_id

string

trace

Array<object>

object

node_id

required

string

type

required

string

Allowed values: input agent tool condition transform output

status

required

string

Allowed values: completed skipped failed

started_at

required

string format: date-time

finished_at

required

string format: date-time

duration_ms

required

integer

selected_branch

string

Allowed values: true false

input_summary

output_summary

Example

{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

413

The bounded Workflow request body is too large.

application/json

Public-safe runtime failure. Fields vary by policy and execution phase.

object

error

required

string

code

string

execution_id

string

node_id

string

trace

Array<object>

object

node_id

required

string

type

required

string

Allowed values: input agent tool condition transform output

status

required

string

Allowed values: completed skipped failed

started_at

required

string format: date-time

finished_at

required

string format: date-time

duration_ms

required

integer

selected_branch

string

Allowed values: true false

input_summary

output_summary

Example

{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

422

A Workflow node failed; a sanitized partial trace may be returned.

application/json

Public-safe runtime failure. Fields vary by policy and execution phase.

object

error

required

string

code

string

execution_id

string

node_id

string

trace

Array<object>

object

node_id

required

string

type

required

string

Allowed values: input agent tool condition transform output

status

required

string

Allowed values: completed skipped failed

started_at

required

string format: date-time

finished_at

required

string format: date-time

duration_ms

required

integer

selected_branch

string

Allowed values: true false

input_summary

output_summary

Example

{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

429

Runtime rate or usage policy denied the request.

application/json

Public-safe runtime failure. Fields vary by policy and execution phase.

object

error

required

string

code

string

execution_id

string

node_id

string

trace

Array<object>

object

node_id

required

string

type

required

string

Allowed values: input agent tool condition transform output

status

required

string

Allowed values: completed skipped failed

started_at

required

string format: date-time

finished_at

required

string format: date-time

duration_ms

required

integer

selected_branch

string

Allowed values: true false

input_summary

output_summary

Example

{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

503

Exact active Capability Release authority could not be proven.

application/json

Public-safe runtime failure. Fields vary by policy and execution phase.

object

error

required

string

code

string

execution_id

string

node_id

string

trace

Array<object>

object

node_id

required

string

type

required

string

Allowed values: input agent tool condition transform output

status

required

string

Allowed values: completed skipped failed

started_at

required

string format: date-time

finished_at

required

string format: date-time

duration_ms

required

integer

selected_branch

string

Allowed values: true false

input_summary

output_summary

Example

{
  "trace": [
    {
      "type": "input",
      "status": "completed",
      "selected_branch": "true"
    }
  ]
}

Run a Workflow

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

Example

400

Example

401

Example

402

Example

403

Example

409

Example

413

Example

422

Example

429

Example

503

Example

Request Body^required

Example^generated