THthe-swarm-corporation
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

  • 500c79520e41Revision changes
    • breaking

      removed from the /// request property anyOf list

    • breaking

      request property //// was restricted to a list of enum values

    • breaking

      the response property / became optional for the status

    • breaking

      removed the required property / from the response with the status

    • warning

      the //// request property's max was set to 2.00

    • warning

      the //// request property's min was set to 1.00

    • warning

      the //// request property's min was set to 0.00

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added subschema #3 to the /// request property anyOf list

    • info

      added subschema #1 to the /// request property anyOf list

    • info

      added subschema #2 to the /// request property anyOf list

    • info

      the request property /// became optional

    • info

      the request property default value changed from true to false

    • info

      the request property default value changed from 8192 to 16000

    • info

      the request property default value changed from gpt-4.1 to claude-sonnet-5

    • info

      the request property default value changed from 10 to 30

    • info

      the request property default value changed from streamable_http to auto

    • info

      the request property default value 0.5 was removed

    • info

      added the new None enum value to the request property ////

    • info

      added the new high enum value to the request property ////

    • info

      added the new low enum value to the request property ////

    • info

      added the new max enum value to the request property ////

    • info

      added the new medium enum value to the request property ////

    • info

      added the new minimal enum value to the request property ////

    • info

      added the new none enum value to the request property ////

    • info

      added the new ultra enum value to the request property ////

    • info

      added the new xhigh enum value to the request property ////

    • info

      request property /// list-of-types was widened by adding types string to media type application/json

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response's property default value 0.01 was added for the status

    • info

      added the required property / to the response with the status