Graph Workflow

Execute Graph Workflow

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

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.

imgstring nullable

Optional image path 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.

{"stackTrail":"components:schemas:GraphWorkflowOutput:properties:outputs","oasType":"schema","type":"unknown","title":"Outputs","description":"The outputs of the graph workflow."}
timestampstring required

The timestamp of the graph workflow execution.

Changes

Changed in 8 of the 49 revisions of this API.4346

  • 2f1c2f28613911See the full diff
    • removed the required property usage/token_cost from the response with the 200 status

      response-required-property-removed

    • added the required property usage/total_cost to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0882a16375db14See the full diff
    • removed MultipleMCPConnections from the agents/anyOf[subschema #1]/items/mcp_configs request property anyOf list

      request-property-any-of-removed

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_urls

      new-optional-request-property

    • added MCPConnection subschema #3 to the agents/anyOf[subschema #1]/items/mcp_url request property anyOf list

      request-property-any-of-added

    • added subschema #1 to the agents/anyOf[subschema #1]/items/mcp_configs request property anyOf list

      request-property-any-of-added

    • added subschema #2 to the agents/anyOf[subschema #1]/items/mcp_config request property anyOf list

      request-property-any-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dd6e1de072c711See the full diff
    • the agents/anyOf[subschema #1]/items/max_tokens/anyOf[subschema #1]/ request property's min was set to 1.00

      request-property-min-set

    • the reasoning_effort request property default value medium was removed

      request-property-default-value-removed

    • added the new optional request property agents/anyOf[subschema #1]/items/fallback_model_name

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/fallback_models

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/top_p

      new-optional-request-property

    • the dynamic_temperature_enabled request property default value changed from true to false

      request-property-default-value-changed

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

      request-property-default-value-changed

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_config/anyOf[subschema #1: MCPConnection]/api_key

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_config/anyOf[subschema #1: MCPConnection]/api_key_header

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_config/anyOf[subschema #1: MCPConnection]/api_key_prefix

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_config/anyOf[subschema #1: MCPConnection]/args

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_config/anyOf[subschema #1: MCPConnection]/auth_type

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_config/anyOf[subschema #1: MCPConnection]/command

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_config/anyOf[subschema #1: MCPConnection]/env

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_config/anyOf[subschema #1: MCPConnection]/name

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_config/anyOf[subschema #1: MCPConnection]/oauth

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_config/anyOf[subschema #1: MCPConnection]/sse_read_timeout

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_config/anyOf[subschema #1: MCPConnection]/tool_timeout

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_configs/anyOf[subschema #1: MultipleMCPConnections]/connections/items/api_key

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_configs/anyOf[subschema #1: MultipleMCPConnections]/connections/items/api_key_header

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_configs/anyOf[subschema #1: MultipleMCPConnections]/connections/items/api_key_prefix

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_configs/anyOf[subschema #1: MultipleMCPConnections]/connections/items/args

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_configs/anyOf[subschema #1: MultipleMCPConnections]/connections/items/auth_type

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_configs/anyOf[subschema #1: MultipleMCPConnections]/connections/items/command

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_configs/anyOf[subschema #1: MultipleMCPConnections]/connections/items/env

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_configs/anyOf[subschema #1: MultipleMCPConnections]/connections/items/name

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_configs/anyOf[subschema #1: MultipleMCPConnections]/connections/items/oauth

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_configs/anyOf[subschema #1: MultipleMCPConnections]/connections/items/sse_read_timeout

      new-optional-request-property

    • added the new optional request property agents/anyOf[subschema #1]/items/mcp_configs/anyOf[subschema #1: MultipleMCPConnections]/connections/items/tool_timeout

      new-optional-request-property

    • the timeout request property default value changed from 10 to 30

      request-property-default-value-changed

    • the timeout request property default value changed from 10 to 30

      request-property-default-value-changed

    • added the new minimal enum value to the request property agents/anyOf[subschema #1]/items/reasoning_effort/anyOf[subschema #1]/

      request-property-enum-value-added

    • added the new none enum value to the request property agents/anyOf[subschema #1]/items/reasoning_effort/anyOf[subschema #1]/

      request-property-enum-value-added

  • a4b2639c845e15See the full diff
    • removed the enum value minimal of the request property agents/anyOf[subschema #1]/items/reasoning_effort/anyOf[subschema #1]/

      request-property-enum-value-removed

    • the max_tokens request property default value changed from 8192 to 16000

      request-property-default-value-changed

    • the reasoning_effort request property default value changed from low to medium

      request-property-default-value-changed

    • added the new max enum value to the request property agents/anyOf[subschema #1]/items/reasoning_effort/anyOf[subschema #1]/

      request-property-enum-value-added

    • added the new ultra enum value to the request property agents/anyOf[subschema #1]/items/reasoning_effort/anyOf[subschema #1]/

      request-property-enum-value-added

    • added the new xhigh enum value to the request property agents/anyOf[subschema #1]/items/reasoning_effort/anyOf[subschema #1]/

      request-property-enum-value-added

  • 9666c890823b124See the full diff
    • request property agents/anyOf[subschema #1]/items/reasoning_effort/anyOf[subschema #1]/ was restricted to a list of enum values

      request-property-became-enum

    • the agents/anyOf[subschema #1]/items/temperature/anyOf[subschema #1]/ request property's max was set to 2.00

      request-property-max-set

    • the agents/anyOf[subschema #1]/items/temperature/anyOf[subschema #1]/ request property's min was set to 0.00

      request-property-min-set

    • added the new high enum value to the request property agents/anyOf[subschema #1]/items/reasoning_effort/anyOf[subschema #1]/

      request-property-enum-value-added

    • added the new low enum value to the request property agents/anyOf[subschema #1]/items/reasoning_effort/anyOf[subschema #1]/

      request-property-enum-value-added

    • added the new medium enum value to the request property agents/anyOf[subschema #1]/items/reasoning_effort/anyOf[subschema #1]/

      request-property-enum-value-added

    • added the new minimal enum value to the request property agents/anyOf[subschema #1]/items/reasoning_effort/anyOf[subschema #1]/

      request-property-enum-value-added