Flows

Learn how to list flows in your workspace

get
List Flows

https://api.robomotion.io/v1/flows.list
This endpoint lists user flows in your workspace
Request
Response
Request
Query Parameters
search
optional
string
Search filter for searching a flow by name
page
optional
integer
Used for pagination
size
optional
integer
Resources per page limit
Response
200: OK
{
"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
List Published Flows

https://api.robomotion.io/v1/flows.listPublished
This endpoint lists published flows in your workspace
Request
Response
Request
Query Parameters
search
optional
string
Search filter for searching a published flow by name
page
optional
integer
Used for pagination
size
optional
integer
Resources per page limit
Response
200: OK
{
"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
List Shared Flows

https://api.robomotion.io/v1/flows.listShared
This endpoint lists shared flows in your workspace
Request
Response
Request
Query Parameters
search
optional
string
Search filter for searching a shared flow by name
page
optional
integer
Used for pagination
size
optional
integer
Resources per page limit
Response
200: OK
{
"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
Delete Flow

https://api.robomotion.io/v1/flows.delete
This endpoint allows to delete a user flow in your workspace
Request
Response
Request
Body Parameters
flow_id
required
string
User flow id
Response
200: OK
{
"ok": true
}

delete
Delete Published Flow

https://api.robomotion.io/v1/flows.deletePublished
This endpoint allows to delete a published flows in your workspace
Request
Response
Request
Body Parameters
flow_id
required
string
Published flow id
Response
200: OK
{
"ok": true
}

delete
Delete Shared Flow

https://api.robomotion.io/v1/flows.deleteShared
This endpoint allows to delete a shared flow in your workspace
Request
Response
Request
Body Parameters
flow_id
required
string
Shared flow id
Response
200: OK
{
"ok": true
}

post
Run Flow

https://api.robomotion.io/v1/flows.run
This endpoint allows to run a user flow on a development robot in your workspace
Request
Response
Request
Body Parameters
robot_id
required
string
Development robot id
flow_id
required
string
User flow id
Response
200: OK
{
"ok": true
}

post
Run Published Flow

https://api.robomotion.io/v1/flows.runPublished
This endpoint allows to run a published flow on a production robot in your workspace.
Request
Response
Request
Body Parameters
robot_id
required
string
Production robot id
flow_id
required
string
Published flow id
Response
200: OK
{
"ok": true
}

post
Stop Robot

https://api.robomotion.io/v1/flows.stop
This endpoint allows to stop a running flow on a robot in your workspace
Request
Response
Request
Body Parameters
robot_id
required
string
Robot id that is running a flow
Response
200: OK