Agent SwarmAgent Swarm

Workflows

Workflows API endpoints

GET
/api/executor-types

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

curl -X GET "http://localhost:3013/api/executor-types"
Empty
GET
/api/executor-types/{type}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

type*string

Response Body

curl -X GET "http://localhost:3013/api/executor-types/string"
Empty
Empty
GET
/api/workflow-runs/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

curl -X GET "http://localhost:3013/api/workflow-runs/string"
Empty
Empty
POST
/api/workflow-runs/{id}/cancel

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?string

Response Body

curl -X POST "http://localhost:3013/api/workflow-runs/string/cancel" \  -H "Content-Type: application/json" \  -d '{}'
Empty
Empty
POST
/api/workflow-runs/{id}/retry

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

curl -X POST "http://localhost:3013/api/workflow-runs/string/retry"
Empty
Empty
GET
/api/workflows

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

curl -X GET "http://localhost:3013/api/workflows"
Empty
POST
/api/workflows

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "http://localhost:3013/api/workflows" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "definition": {      "nodes": [        {          "id": "string",          "type": "string",          "config": {            "property1": null,            "property2": null          }        }      ]    }  }'
Empty
Empty
DELETE
/api/workflows/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

curl -X DELETE "http://localhost:3013/api/workflows/string"
Empty
Empty
GET
/api/workflows/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

curl -X GET "http://localhost:3013/api/workflows/string"
Empty
Empty
PATCH
/api/workflows/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "http://localhost:3013/api/workflows/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
Empty
Empty
PUT
/api/workflows/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PUT "http://localhost:3013/api/workflows/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
Empty
Empty
PATCH
/api/workflows/{id}/nodes/{nodeId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
nodeId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "http://localhost:3013/api/workflows/string/nodes/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
Empty
Empty
GET
/api/workflows/{id}/runs

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Query Parameters

status?string
Value in"running" | "waiting" | "completed" | "failed" | "skipped" | "cancelled"

Response Body

curl -X GET "http://localhost:3013/api/workflows/string/runs"
Empty
POST
/api/workflows/{id}/trigger

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

curl -X POST "http://localhost:3013/api/workflows/string/trigger"
Empty
Empty
Empty
Empty
GET
/api/workflows/{id}/versions

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

curl -X GET "http://localhost:3013/api/workflows/string/versions"
Empty
Empty
GET
/api/workflows/{id}/versions/{version}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
version*integer
Range1 <= value

Response Body

curl -X GET "http://localhost:3013/api/workflows/string/versions/1"
Empty
Empty

Webhooks

Webhooks API endpoints