Create Workflow

POST/v1/workflows

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

Request Body (JSON)

Request Body

Property	Type	Required
`tenantId`	`string`	No
`name`	`string`	No
`description`	`string`	No
`nodes`	`object[]`	No
`edges`	`object[]`	No
`viewport`	`object`	No

Responses

200 Create a new workflow

Property	Type	Description
`workflow`	`object`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/v1/workflows" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tenantId":"string","name":"string","description":"string","nodes":[{"id":"string","type":"string","label":"string","position":{"x":0,"y":0}}],"edges":[{"id":"string","source":"string","target":"string","sourceHandle":"string","targetHandle":"string"}],"viewport":{"x":0,"y":0,"zoom":0}}'

const response = await fetch("http://localhost:8089/v1/workflows", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "nodes": [
    {
      "id": "string",
      "type": "string",
      "label": "string",
      "position": {
        "x": 0,
        "y": 0
      }
    }
  ],
  "edges": [
    {
      "id": "string",
      "source": "string",
      "target": "string",
      "sourceHandle": "string",
      "targetHandle": "string"
    }
  ],
  "viewport": {
    "x": 0,
    "y": 0,
    "zoom": 0
  }
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/workflows",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "nodes": [
    {
      "id": "string",
      "type": "string",
      "label": "string",
      "position": {
        "x": 0,
        "y": 0
      }
    }
  ],
  "edges": [
    {
      "id": "string",
      "source": "string",
      "target": "string",
      "sourceHandle": "string",
      "targetHandle": "string"
    }
  ],
  "viewport": {
    "x": 0,
    "y": 0,
    "zoom": 0
  }
},
)
data = response.json()

Response

{
  "workflow": {
    "id": "string",
    "tenantId": "string",
    "name": "string",
    "description": "string",
    "nodes": [
      {
        "id": "string",
        "type": "string",
        "label": "string"
      }
    ],
    "edges": [
      {
        "id": "string",
        "source": "string",
        "target": "string",
        "sourceHandle": "string",
        "targetHandle": "string"
      }
    ],
    "viewport": {
      "x": 0,
      "y": 0,
      "zoom": 0
    },
    "enabled": true,
    "version": 0,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}