Flows

Create Flow

Creates a new flow with the provided details

POSThttps://api.laminar.run/flows

Body

application/json

workflowId*integer (int64)

name*string

description*string

program*string

executionOrder*integer (int32)

sourceIdinteger (int64)

destinationIdinteger (int64)

sourceApiDescription (object)

destinationApiDescription (object)

Response

200

Flow created successfully

Body

*/*

idinteger (int64)

name*string

description*string

currentFlowVersionFlowVersion (object)

executionOrder*integer (int32)

createdAtstring (date-time)

sourceApiDescription (object)

destinationApiDescription (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.laminar.run/flows', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "executionOrder": 0,
      "name": "text",
      "program": "text",
      "workflowId": 0
    }),
});
const data = await response.json();

Response

200

{
  "id": 0,
  "name": "text",
  "description": "text",
  "currentFlowVersion": {
    "id": 0,
    "createdAt": "2024-12-21T11:39:54.097Z"
  },
  "executionOrder": 0,
  "createdAt": "2024-12-21T11:39:54.097Z",
  "source": {
    "id": 0,
    "url": "text",
    "methodType": "GET",
    "authCredentials": {
      "id": 0,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text"
  },
  "destination": {
    "id": 0,
    "url": "text",
    "methodType": "GET",
    "authCredentials": {
      "id": 0,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text"
  }
}

Update Flow

Updates an existing flow with the provided details

PUThttps://api.laminar.run/flows

Body

application/json

flowId*integer (int64)

namestring

descriptionstring

programstring

sourceApiDescription (object)

destinationApiDescription (object)

sourceIdinteger (int64)

destinationIdinteger (int64)

Response

200

Flow updated successfully

Body

*/*

idinteger (int64)

name*string

description*string

currentFlowVersionFlowVersion (object)

executionOrder*integer (int32)

createdAtstring (date-time)

sourceApiDescription (object)

destinationApiDescription (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.laminar.run/flows', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "flowId": 0
    }),
});
const data = await response.json();

Response

200

{
  "id": 0,
  "name": "text",
  "description": "text",
  "currentFlowVersion": {
    "id": 0,
    "createdAt": "2024-12-21T11:39:54.097Z"
  },
  "executionOrder": 0,
  "createdAt": "2024-12-21T11:39:54.097Z",
  "source": {
    "id": 0,
    "url": "text",
    "methodType": "GET",
    "authCredentials": {
      "id": 0,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text"
  },
  "destination": {
    "id": 0,
    "url": "text",
    "methodType": "GET",
    "authCredentials": {
      "id": 0,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text"
  }
}

Get Flow

Retrieves a specific flow's details

GEThttps://api.laminar.run/flows/{id}

Path parameters

id*integer (int64)

Response

200404

Flow details retrieved successfully

Body

*/*

idinteger (int64)

name*string

description*string

currentFlowVersionFlowVersion (object)

executionOrder*integer (int32)

createdAtstring (date-time)

sourceApiDescription (object)

destinationApiDescription (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.laminar.run/flows/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": 0,
  "name": "text",
  "description": "text",
  "currentFlowVersion": {
    "id": 0,
    "createdAt": "2024-12-21T11:39:54.097Z"
  },
  "executionOrder": 0,
  "createdAt": "2024-12-21T11:39:54.097Z",
  "source": {
    "id": 0,
    "url": "text",
    "methodType": "GET",
    "authCredentials": {
      "id": 0,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text"
  },
  "destination": {
    "id": 0,
    "url": "text",
    "methodType": "GET",
    "authCredentials": {
      "id": 0,
      "name": "text",
      "authType": "text"
    },
    "name": "text",
    "description": "text"
  }
}

Delete Flow

Deletes a specific flow

DELETEhttps://api.laminar.run/flows/{id}

Path parameters

id*integer (int64)

Response

200

Flow deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('https://api.laminar.run/flows/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();