Skip to main content

Robots

GET /v1/robots.list

List robots

This endpoint allows you to list robots in your workspace.

Query Parameters

ParameterTypeDescription
searchstringSearch filter for searching the robot by name
pageintegerUsed for pagination
sizeintegerResources per page limit

Response


"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 /v1/robots.create

Create robot

This endpoint allows creating 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.

Body Parameters

ParameterTypeDescription
namestringRobot name
typestringRobot type can be either "development", "ondemand" or "production"

Response


{
"ok": true,
"robot": {
"id": "20f1cdb9-d8d9-448b-984c-9188deb24e8e",
"workspace_id": "db4c4965-7389-4160-a1cc-4181975fe1e8",
"name": "Jarvis",
"type": "development"
}
}

POST /v1/robots.update

Update robot

This endpoint allows to update robot in your workspace.

Body Parameters

ParameterTypeDescription
robot_idstringWorkspace robot id
namestringRobot name

Response


{
"ok": true
}

POST /v1/robots.stop

Stop robot

This endpoint allows to stop a running robot forcibly.

Body Parameters

ParameterTypeDescription
robot_idstringWorkspace robot id
studio_idstringWorkspace studio id

Response


{
"ok": true
}

DELETE /v1/robots.delete

Delete robot

This endpoint allows to delete a robot in your workspace.

Body Parameters

ParameterTypeDescription
robot_idstringWorkspace robot id

Response


{
"ok": true
}