Flows

GET /v1/flows.list

List flows

This endpoint lists user flows in your workspace.

Query Parameters

Parameter	Type	Description
search	string	Search filter for searching a flow by name
page	integer	Used for pagination
size	integer	Resources per page limit

Response

{
	"ok": true,
	"flows": [{
		"id": "90fb951c-dce6-40e5-9318-08aecb4742d1",
		"created_at": "2020-01-19T13:34:20.519077Z",
		"updated_at": "2020-01-19T14:27:53.921718Z",
		"workspace_id": "f9ddef7e-a76c-4b7e-bdcc-8e7d2476a393",
		"creator_id": "eaec19c5-95fe-441a-b37c-c427c30034a2",
		"name": "Simple Browser Example"
	}],
	"total": 1
}

GET /v1/flows.listPublished

List Published Flows

This endpoint lists published flows in your workspace.

Query Parameters

Parameter	Type	Description
search	string	Search filter for searching a published flow by name
page	integer	Used for pagination
size	integer	Resources per page limit

Response

{
	"ok": true,
	"flows": [{
		"id": "c41c25f8-792e-4618-b1ee-19d55afbec2e",
		"created_at": "2020-01-19T13:34:50.939513Z",
		"updated_at": "2020-01-19T14:27:54.324752Z",
		"workspace_id": "f9ddef7e-a76c-4b7e-bdcc-8e7d2476a393",
		"publisher_id": "eaec19c5-95fe-441a-b37c-c427c30034a2",
		"flow_id": "90fb951c-dce6-40e5-9318-08aecb4742d1",
		"version_id": "90fb951c-dce6-40e5-9318-08aecb4742d1",
		"name": "Simple Browser Example"
	}],
	"total": 1
}

GET /v1/flows.listShared

List Shared Flows

This endpoint lists shared flows in your workspace.

Query Parameters

Parameter	Type	Description
search	string	Search filter for searching a shared flow by name
page	integer	Used for pagination
size	integer	Resources per page limit

Response

{
	"ok": true,
	"flows": [{
		"id": "99cc6239-c101-45f0-a0d1-69316f8be9a5",
		"workspace_id": "f9ddef7e-a76c-4b7e-bdcc-8e7d2476a393",
		"user_id": "eaec19c5-95fe-441a-b37c-c427c30034a2",
		"name": "Simple Browser Example",
		"privacy": "workspace",
		"shared_at": "2020-01-20T14:36:22.323943Z"
	}],
	"total": 0
}

DELETE /v1/flows.delete

Delete flow

This endpoint allows deleting a user flow in your workspace.

Body Parameters

Parameter	Type	Description
flow_id	string	User flow id

Response

{
	"ok": true
}

DELETE /v1/flows.deletePublished

Delete published flow

This endpoint allows to delete a published flows in your workspace.

Body Parameters

Parameter	Type	Description
flow_id	string	Published flow id

Response

{
	"ok": true
}

DELETE /v1/flows.deleteShared

Delete shared flow

This endpoint allows deleting a shared flow in your workspace.

Body Parameters

Parameter	Type	Description
flow_id	string	Shared flow id

Response

{
	"ok": true
}

POST /v1/flows.run

Run flow

This endpoint allows you to run a user flow on a development robot in your workspace.

Body Parameters

Parameter	Type	Description
robot_id	string	Development robot id
flow_id	string	User flow id

Response

{
	"ok": true
}

POST /v1/flows.runPublished

Run Published flow

This endpoint allows to run a published flow on a production robot in your workspace.

Body Parameters

Parameter	Type	Description
robot_id	string	Production robot id
flow_id	string	User flow id

Response

{
	"ok": true
}

POST /v1/flows.stop

Stop flow

This endpoint allows to stop a running flow on a robot in your workspace.

Body Parameters

Parameter	Type	Description
robot_id	string	Robot id that is running a flow

Response

{
	"ok": true
}