Graphs

Create, update, execute, and manage workflow graphs, nodes, and edges.

createGraph

Create a new workflow graph

POST

Usage:

const result = await swirls.client.graphs.createGraph({
  projectId: '...',
  name: '...',
  label: '...',
})

Input:

Output:

getGraph

Get a graph with all its nodes and edges. Each node has position: { x, y } (canvas coordinates). Use this to understand workflow structure and existing layout. Before creating or updating nodes, call this to see existing positions so you can place new nodes and adjust positions for a visually compelling flow (e.g. left-to-right, consistent spacing, no overlap). Each node also includes inputSchema and outputSchema — inspect these before calling execute_graph.

GET

Usage:

const result = await swirls.client.graphs.getGraph({
  id: '...',
})

Input:

Output:

updateGraph

Update an existing graph

PUT

Usage:

const result = await swirls.client.graphs.updateGraph({
  id: '...',
})

Input:

Output:

deleteGraph

Delete a graph

DELETE

Usage:

const result = await swirls.client.graphs.deleteGraph({
  id: '...',
})

Input:

listGraphs

List all graphs in a project

GET

Usage:

const result = await swirls.client.graphs.listGraphs({
  projectId: '...',
})

Input:

Output:

createNode

Create a new node in a graph. For a visually compelling flow: call get_graph first to get existing nodes and their position { "x", "y" }; place the new node considering the layout—e.g. left-to-right (increase x for downstream), stack vertically (vary y), use ~150–200px spacing between nodes, avoid overlap. Position format: { "x": number, "y": number }. Node types and their configs:

POST

Usage:

const result = await swirls.client.graphs.createNode({
  graphId: '...',
  name: '...',
  label: '...',
  type: '...',
  config: {},
})

Input:

Output:

updateNode

Update an existing node. For layout: call get_graph to see all nodes and edges; set position { "x", "y" } to improve flow—align with connected nodes, leave ~150–200px spacing, keep left-to-right or top-to-bottom order for a visually compelling layout.

PUT

Usage:

const result = await swirls.client.graphs.updateNode({
  id: '...',
})

Input:

Output:

deleteNode

Delete a node from a graph

DELETE

Usage:

const result = await swirls.client.graphs.deleteNode({
  id: '...',
})

Input:

createEdge

Create an edge connecting two nodes. Edges define the flow of data between nodes. Cycles are not allowed.

POST

Usage:

const result = await swirls.client.graphs.createEdge({
  graphId: '...',
  sourceNodeId: '...',
  targetNodeId: '...',
})

Input:

Output:

deleteEdge

Delete an edge from a graph

DELETE

Usage:

const result = await swirls.client.graphs.deleteEdge({
  id: '...',
})

Input:

syncGraph

Sync a complete graph structure with nodes and edges. This is the most efficient way to create or update a complete workflow in one operation. Each node can include position: { "x": number, "y": number }. For a visually compelling flow, assign positions so nodes run left-to-right (or top-to-bottom), with ~150–200px spacing and no overlap; consider edge connections when placing nodes.

POST

Usage:

const result = await swirls.client.graphs.syncGraph({
  graphId: '...',
  nodes: [],
  edges: [],
})

Input:

Output:

executeGraph

Execute a graph with input data. Returns an execution ID that can be used to track progress via get_execution.

POST

Usage:

const result = await swirls.client.graphs.executeGraph({
  graphId: '...',
})

Input:

Output:

getExecution

Get the status and results of a graph execution, including all node executions. Use the executionId returned by execute_graph. The response includes the overall status and each node's individual execution status and output.

GET

Usage:

const result = await swirls.client.graphs.getExecution({
  id: '...',
})

Input:

Output:

listExecutions

List executions for a graph

GET

Usage:

const result = await swirls.client.graphs.listExecutions({
  graphId: '...',
})

Input:

Output:

listTriggers

GET

Usage:

const result = await swirls.client.graphs.listTriggers({
  graphId: '...',
})

Input:

Output:

getStream

GET

Usage:

const result = await swirls.client.graphs.getStream({
  graphId: '...',
})

Input: