Skip to main content

Flows API

Manage flows programmatically with the Flows API.

List Flows

GET /api/v1/flows

Returns all flows in the workspace.

Response

{
  "flows": [
    {
      "id": "flow-1",
      "name": "Temperature Monitor",
      "enabled": true,
      "nodes": 12
    }
  ]
}

Get Flow

GET /api/v1/flows/{id}

Returns a specific flow with all its nodes and connections.

Create Flow

POST /api/v1/flows
Content-Type: application/json

{
  "name": "My New Flow",
  "nodes": [],
  "connections": []
}

Update Flow

PUT /api/v1/flows/{id}
Content-Type: application/json

{
  "name": "Updated Flow Name",
  "enabled": false
}

Delete Flow

DELETE /api/v1/flows/{id}

Deploy Flow

POST /api/v1/flows/{id}/deploy

Deploys the flow to make changes active.