create
Developing
POST
flows
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'flows' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"projectId": "string",
"name": "string",
"description": "string",
"version": "string",
"metadata": {},
"tags": [
"string"
],
"nodes": [
{
"id": "string",
"type": "string",
"position": {
"x": 0,
"y": 0
},
"data": {},
"displayOrder": 0,
"connectionId": "string"
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"sourceHandle": "string",
"targetHandle": "string",
"metadata": {}
}
],
"connectionId": "string"
}'Response Response Example
{
"message": "Flow created successfully",
"flow": {
"id": "2895ac8d-b6db-469c-9f39-5180a051918c",
"projectId": "8dbae2e7-911e-476c-9861-e368613f09dc",
"createdById": "00000000-0000-0000-0000-000000000001",
"name": "m2s_demo_job",
"description": null,
"version": "1.0",
"metadata": {
"catalog": "hive_prod"
},
"tags": [],
"createdAt": "2026-02-04T06:32:58.329Z",
"updatedAt": "2026-02-04T06:32:58.329Z",
"lockedById": "00000000-0000-0000-0000-000000000001",
"lockedAt": "2026-02-04T06:32:58.328Z",
"nodes": [
{
"id": "becb22c6-8470-4a8e-8a66-fd704231001c",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"type": "source",
"position": {
"x": 80,
"y": 80
},
"data": {
"alias": "txn",
"table": "dm.txn",
"sourceType": "table"
},
"displayOrder": 0,
"createdAt": "2026-02-04T06:32:58.332Z",
"updatedAt": "2026-02-04T06:32:58.332Z"
},
{
"id": "5016532e-c342-48ea-81c3-7d74f42c2fb0",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"type": "filter",
"position": {
"x": 380,
"y": 90
},
"data": {
"condition": "amount > 0"
},
"displayOrder": 1,
"createdAt": "2026-02-04T06:32:58.335Z",
"updatedAt": "2026-02-04T06:32:58.335Z"
},
{
"id": "1f8433b3-de56-44a1-960d-d9119700c587",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"type": "aggregate",
"position": {
"x": 680,
"y": 80
},
"data": {
"aggs": [
{
"expr": "sum(amount)",
"alias": "total_amount"
},
{
"expr": "count(1)",
"alias": "tx_count"
}
],
"groupBy": [
"customer_id"
]
},
"displayOrder": 2,
"createdAt": "2026-02-04T06:32:58.338Z",
"updatedAt": "2026-02-04T06:32:58.338Z"
},
{
"id": "c79b3c37-d47f-4fc7-97bc-467319a54e91",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"type": "source",
"position": {
"x": 680,
"y": 260
},
"data": {
"path": "/data/raw/customers",
"alias": "customers",
"format": "parquet",
"sourceType": "path"
},
"displayOrder": 3,
"createdAt": "2026-02-04T06:32:58.341Z",
"updatedAt": "2026-02-04T06:32:58.341Z"
},
{
"id": "dbf3828c-4a9f-42f9-b82b-9a572336da82",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"type": "join",
"position": {
"x": 980,
"y": 170
},
"data": {
"on": "l.customer_id = r.id",
"how": "left",
"leftKey": "customer_id",
"rightKey": "id"
},
"displayOrder": 4,
"createdAt": "2026-02-04T06:32:58.344Z",
"updatedAt": "2026-02-04T06:32:58.344Z"
},
{
"id": "dc38af9d-7e37-4f23-9b1b-ae9401ab264e",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"type": "derive",
"position": {
"x": 1280,
"y": 170
},
"data": {
"columns": [
{
"expr": "total_amount / nullif(tx_count, 0)",
"name": "avg_txn"
}
]
},
"displayOrder": 5,
"createdAt": "2026-02-04T06:32:58.347Z",
"updatedAt": "2026-02-04T06:32:58.347Z"
},
{
"id": "eeb2e302-2689-43aa-a549-77ad70e57d59",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"type": "sink",
"position": {
"x": 1580,
"y": 170
},
"data": {
"keys": [
"customer_id"
],
"table": "dm.customer_metrics",
"catalog": "hive_prod",
"sinkType": "iceberg_merge"
},
"displayOrder": 6,
"createdAt": "2026-02-04T06:32:58.349Z",
"updatedAt": "2026-02-04T06:32:58.349Z"
}
],
"edges": [
{
"id": "1dea4ff3-4fdf-4100-98f6-7b0551d6e900",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"source": "becb22c6-8470-4a8e-8a66-fd704231001c",
"target": "5016532e-c342-48ea-81c3-7d74f42c2fb0",
"sourceHandle": "out",
"targetHandle": "in",
"metadata": {},
"createdAt": "2026-02-04T06:32:58.351Z",
"updatedAt": "2026-02-04T06:32:58.351Z"
},
{
"id": "fb6957db-f9e8-45d9-b72b-435526bcc103",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"source": "5016532e-c342-48ea-81c3-7d74f42c2fb0",
"target": "1f8433b3-de56-44a1-960d-d9119700c587",
"sourceHandle": "out",
"targetHandle": "in",
"metadata": {},
"createdAt": "2026-02-04T06:32:58.351Z",
"updatedAt": "2026-02-04T06:32:58.351Z"
},
{
"id": "32729ca4-4a91-4730-820d-067f368d3e9d",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"source": "1f8433b3-de56-44a1-960d-d9119700c587",
"target": "dbf3828c-4a9f-42f9-b82b-9a572336da82",
"sourceHandle": "out",
"targetHandle": "left",
"metadata": {},
"createdAt": "2026-02-04T06:32:58.351Z",
"updatedAt": "2026-02-04T06:32:58.351Z"
},
{
"id": "2aea70f5-1254-4c73-b309-a3d4feeb216a",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"source": "c79b3c37-d47f-4fc7-97bc-467319a54e91",
"target": "dbf3828c-4a9f-42f9-b82b-9a572336da82",
"sourceHandle": "out",
"targetHandle": "right",
"metadata": {},
"createdAt": "2026-02-04T06:32:58.351Z",
"updatedAt": "2026-02-04T06:32:58.351Z"
},
{
"id": "51f711fd-04d1-4b50-a1df-9613037fa391",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"source": "dbf3828c-4a9f-42f9-b82b-9a572336da82",
"target": "dc38af9d-7e37-4f23-9b1b-ae9401ab264e",
"sourceHandle": "out",
"targetHandle": "in",
"metadata": {},
"createdAt": "2026-02-04T06:32:58.351Z",
"updatedAt": "2026-02-04T06:32:58.351Z"
},
{
"id": "0b599b4a-90fa-4a93-bace-94efed329773",
"flowId": "2895ac8d-b6db-469c-9f39-5180a051918c",
"source": "dc38af9d-7e37-4f23-9b1b-ae9401ab264e",
"target": "eeb2e302-2689-43aa-a549-77ad70e57d59",
"sourceHandle": "out",
"targetHandle": "in",
"metadata": {},
"createdAt": "2026-02-04T06:32:58.351Z",
"updatedAt": "2026-02-04T06:32:58.351Z"
}
],
"lockedBy": {
"id": "00000000-0000-0000-0000-000000000001",
"email": "admin@spark.local",
"name": "Default Admin"
},
"createdBy": {
"id": "00000000-0000-0000-0000-000000000001",
"email": "admin@spark.local",
"name": "Default Admin"
}
}
}Modified at 2026-03-30 16:29:35