Flows

Create Flow

Creates a new flow with the provided details

post

/flows

Authorizations

Body

workflowIdinteger · int64required

namestringrequired

descriptionstringrequired

programstringrequired

executionOrderinteger · int32required

sourceIdinteger · int64

destinationIdinteger · int64

sourceobject

destinationobject

languagestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.laminar.run/flows' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "workflowId": 1,
    "name": "text",
    "description": "text",
    "program": "text",
    "executionOrder": 1,
    "sourceId": 1,
    "destinationId": 1,
    "source": {
      "id": 1,
      "url": "text",
      "authCredentials": {
        "id": 1,
        "name": "text",
        "authType": "text"
      },
      "name": "text",
      "description": "text",
      "methodType": "GET"
    },
    "destination": {
      "id": 1,
      "url": "text",
      "authCredentials": {
        "id": 1,
        "name": "text",
        "authType": "text"
      },
      "name": "text",
      "description": "text",
      "methodType": "GET"
    },
    "language": "text"
  }'

200

200

{
  "id": 1,
  "name": "text",
  "description": "text",
  "language": "text",
  "currentFlowVersion": {
    "id": 1,
    "createdAt": "2025-02-28T07:15:18.878Z"
  },
  "executionOrder": 1,
  "createdAt": "2025-02-28T07:15:18.878Z",
  "source": {
    "id": 1,
    "url": "text",
    "authCredentials": {
      "id": 1,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text",
    "methodType": "GET"
  },
  "destination": {
    "id": 1,
    "url": "text",
    "authCredentials": {
      "id": 1,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text",
    "methodType": "GET"
  }
}

Flow created successfully

Update Flow

Updates an existing flow with the provided details

put

/flows

Authorizations

Body

flowIdinteger · int64required

namestring

descriptionstring

programstring

sourceobject

destinationobject

sourceIdinteger · int64

destinationIdinteger · int64

languagestring

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.laminar.run/flows' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "flowId": 1,
    "name": "text",
    "description": "text",
    "program": "text",
    "source": {
      "id": 1,
      "url": "text",
      "authCredentials": {
        "id": 1,
        "name": "text",
        "authType": "text"
      },
      "name": "text",
      "description": "text",
      "methodType": "GET"
    },
    "destination": {
      "id": 1,
      "url": "text",
      "authCredentials": {
        "id": 1,
        "name": "text",
        "authType": "text"
      },
      "name": "text",
      "description": "text",
      "methodType": "GET"
    },
    "sourceId": 1,
    "destinationId": 1,
    "language": "text"
  }'

200

200

{
  "id": 1,
  "name": "text",
  "description": "text",
  "language": "text",
  "currentFlowVersion": {
    "id": 1,
    "createdAt": "2025-02-28T07:15:18.878Z"
  },
  "executionOrder": 1,
  "createdAt": "2025-02-28T07:15:18.878Z",
  "source": {
    "id": 1,
    "url": "text",
    "authCredentials": {
      "id": 1,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text",
    "methodType": "GET"
  },
  "destination": {
    "id": 1,
    "url": "text",
    "authCredentials": {
      "id": 1,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text",
    "methodType": "GET"
  }
}

Flow updated successfully

Get Flow

Retrieves a specific flow's details

get

/flows/{id}

Authorizations

Path parameters

idinteger · int64required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.laminar.run/flows/{id}' \
  --header 'Authorization: Bearer JWT'

200

404

200

{
  "id": 1,
  "name": "text",
  "description": "text",
  "language": "text",
  "currentFlowVersion": {
    "id": 1,
    "createdAt": "2025-02-28T07:15:18.878Z"
  },
  "executionOrder": 1,
  "createdAt": "2025-02-28T07:15:18.878Z",
  "source": {
    "id": 1,
    "url": "text",
    "authCredentials": {
      "id": 1,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text",
    "methodType": "GET"
  },
  "destination": {
    "id": 1,
    "url": "text",
    "authCredentials": {
      "id": 1,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text",
    "methodType": "GET"
  }
}

Flow details retrieved successfully

Delete Flow

Deletes a specific flow

delete

/flows/{id}

Authorizations

Path parameters

idinteger · int64required

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.laminar.run/flows/{id}' \
  --header 'Authorization: Bearer JWT'

200

200

No body

Flow deleted successfully