Graphs

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

getGraphSnapshot

Get a graph snapshot with all its nodes and edges. Each node has position: { x, y } (canvas coordinates). Use before executeGraph.

GET

Usage:

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

Input:

Output:

listGraphs

List one row per stable graph with preferred snapshot, version count, and active-deployment flag.

GET

Usage:

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

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:

listRunnableGraphs

List graphs in a deployment with each graph's entry node input schema and last execution. id in each row is the graph snapshot id. Last execution aggregates by stable graph when possible.

GET

Usage:

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

Input:

Output: