Robots

Learn how to manage robots in your workspace

get
List robots

https://api.robomotion.io/v1/robots.list
This endpoint allows you to list robots in your workspace
Request
Response
Request
Query Parameters
search
optional
string
Search filter for searching the robot by name
page
optional
integer
Used for pagination
size
optional
integer
Resources per page limit
Response
200: OK
{
"ok": true,
"robots": [{
"id": "624609c6-1a27-458f-ace5-3889dc554e28",
"workspace_id": "db4c4965-7389-4160-a1cc-4181975fe1e8",
"name": "Butler",
"type": "production"
}, {
"id": "20f1cdb9-d8d9-448b-984c-9188deb24e8e",
"workspace_id": "db4c4965-7389-4160-a1cc-4181975fe1e8",
"name": "Jarvis",
"type": "development"
}],
"total": 2
}

post
Update robot

https://api.robomotion.io/v1/robots.update
This endpoint allows to update robot in your workspace
Request
Response
Request
Body Parameters
robot_id
required
string
Workspace robot id
name
required
string
Robot name
Response
200: OK
{
"ok": true
}

delete
Delete robot

https://api.robomotion.io/v1/robots.delete
This endpoint allows to delete a robot in your workspace
Request
Response
Request
Body Parameters
robot_id
required
string
Workspace robot id
Response
200: OK
{
"ok": true
}

post
Create robot

https://api.robomotion.io/v1/robots.create
This endpoint allows to create a robot in your workspace. You are allowed to add new robots to your workspace as long as the number of robots does not exceed the total licensed count.
Request
Response
Request
Body Parameters
name
required
string
Robot name
type
required
string
Robot type can be either "development", "ondemand" or "production"
Response
200: OK
{
"ok": true,
"robot": {
"id": "20f1cdb9-d8d9-448b-984c-9188deb24e8e",
"workspace_id": "db4c4965-7389-4160-a1cc-4181975fe1e8",
"name": "Jarvis",
"type": "development"
}
}