SWswarms
Graph Workflow

Execute Graph Workflow

Changed on

Execute a graph workflow with directed agent nodes and edges. Enables complex multi-agent collaboration with parallel execution, automatic compilation, and comprehensive workflow orchestration.

post/v1/graph-workflow/completions

Request

  • Base URL
    https://api.swarms.world
  • URL
    https://api.swarms.world/v1/graph-workflow/completions
  • Auth
    none declared. Required headers: x-api-key

Headers

x-api-keystring required

Request body

namestring nullable

The name of the graph workflow.

descriptionstring nullable

The description of the graph workflow.

entry_pointsstring[] nullable

List of node IDs that serve as starting points for the workflow.

end_pointsstring[] nullable

List of node IDs that serve as ending points for the workflow.

max_loopsinteger nullable

The maximum number of execution loops for the workflow.

taskstring nullable

The task to be executed by the workflow. Required: a missing or blank task returns 400.

imgstring nullable

Optional https:// image URL or base64 encoded image for vision-enabled agents.

auto_compileboolean nullable

Whether to automatically compile the workflow for optimization.

verboseboolean nullable

Whether to enable detailed logging.

Response

Successful Response

job_idstring required

The job ID of the graph workflow.

namestring nullable

The name of the graph workflow.

descriptionstring nullable

The description of the graph workflow.

statusstring required

The status of the graph workflow.

outputsunknown required
timestampstring required

The timestamp of the graph workflow execution.

Changes

  • 3e13975ede3dRevision changes
    • info

      added the optional property / to the response with the status

  • ee4273b4b6aeRevision changes
    • info

      the request property default value changed from streamable_http to auto

    • info

      the request property default value changed from streamable_http to auto

    • info

      the request property default value changed from streamable_http to auto

    • info

      the request property default value changed from streamable_http to auto