Robot Management

These endpoints allow you to register, retrieve, update, and remove robots from your organization.

Create Robot

Registers a new autonomous system (e.g., Spot, UR6) within your organization.

• Endpoint: /api/robot/create
• Method: POST

Request Headers

Key	Value	Required
Content-Type	application/json	Yes
X-API-KEY	Your-API-Key	Yes

Request Body

The body must contain a root params object.

Parameter	Type	Required	Description
params.robot_name	string	Yes	Unique name for the robot (e.g., “SDK-Test-Bot-01”).
params.robot_type	enum	Yes	Must be one of: spot, ur6.

Success Response

Code: 200 OK

{
  "created_time": "2026-01-07T10:00:00",
  "message": "Robot created",
  "modified_time": "2026-01-07T10:00:00",
  "robot_id": "e7201eff-e29b-41d4-a716-446655440000",
  "robot_name": "SDK-Test-Bot-01",
  "robot_type": "spot"
}

Possible Errors

• RS-ROBOT-001: Robot name already exists.
• RS-VAL-003: Invalid robot type.
• 401 Unauthorized: Invalid or missing API Key.

Sample Code (Python)

import requests

url = "[https://api.ridescan.ai/api/robot/create](https://api.ridescan.ai/api/robot/create)"
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": "YOUR_API_KEY"
}
payload = {
    "params": {
        "robot_name": "SDK-Test-Bot-01",
        "robot_type": "spot"
    }
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

---

Get Robots

Retrieves details for a specific robot or searches for robots by name/type.

• Admins: See all robots in the Organization.
• L2 Users: See only robots they created.
• Endpoint: /api/getrobot
• Method: POST

Request Headers

Key	Value	Required
Content-Type	application/json	Yes
X-API-KEY	Your-API-Key	Yes

Request Body

The body uses a criteria object for filtering. All fields are optional; if omitted, all accessible robots are returned.

Parameter	Type	Required	Description
criteria.robot_id	uuid	No	Filter by specific Robot UUID.
criteria.robot_name	string	No	Filter by exact robot name.
criteria.robot_type	string	No	Filter by robot type (e.g., spot).

Success Response

Code: 200 OK

[
  {
    "created_time": "2026-01-07T10:00:00",
    "modified_time": "2026-01-07T12:00:00",
    "robot_id": "e7201eff-e29b-41d4-a716-446655440000",
    "robot_name": "SDK-Test-Bot-01",
    "robot_type": "spot"
  }
]

Possible Errors

• RS-ROBOT-004: Robot ID not found.
• 401 Unauthorized: Invalid or missing API Key.

Sample Code (Python)

import requests

url = "[https://api.ridescan.ai/api/getrobot](https://api.ridescan.ai/api/getrobot)"
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": "YOUR_API_KEY"
}
# Example: Search by ID
payload = {
    "criteria": {
        "robot_id": "e7201eff-e29b-41d4-a716-446655440000"
    }
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

---

Edit Robot

Updates a robot’s details. Requires identifying the robot via criteria and providing new values via params.

• Endpoint: /api/editrobot
• Method: PATCH

Request Headers

Key	Value	Required
Content-Type	application/json	Yes
X-API-KEY	Your-API-Key	Yes

Request Body

Parameter	Type	Required	Description
criteria.robot_id	uuid	Yes	The UUID of the robot to update.
params.robot_name	string	No	New name for the robot.
params.robot_type	string	No	New type for the robot.

Note: You must provide at least one field in params to update.

Success Response

Code: 200 OK

{
  "created_time": "2026-01-07T10:00:00",
  "message": "Robot edited",
  "modified_time": "2026-01-07T12:30:00",
  "robot_id": "e7201eff-e29b-41d4-a716-446655440000",
  "robot_name": "SDK-Test-Bot-01-Edited",
  "robot_type": "spot"
}

Possible Errors

• RS-ROBOT-004: Robot ID not found.
• RS-ROBOT-001: Robot name already exists.
• 401 Unauthorized: Invalid or missing API Key.

Sample Code (Python)

import requests

url = "[https://api.ridescan.ai/api/editrobot](https://api.ridescan.ai/api/editrobot)"
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": "YOUR_API_KEY"
}
payload = {
    "criteria": {
        "robot_id": "e7201eff-e29b-41d4-a716-446655440000"
    },
    "params": {
        "robot_name": "SDK-Test-Bot-01-Edited"
    }
}

response = requests.patch(url, json=payload, headers=headers)
print(response.json())

---

Delete Robot

Permanently deletes a robot and all associated missions and files.

• Endpoint: /api/deleterobot
• Method: DELETE

Request Headers

Key	Value	Required
Content-Type	application/json	Yes
X-API-KEY	Your-API-Key	Yes

Request Body

The body uses a criteria object to identify the robot.

Parameter	Type	Required	Description
criteria.robot_id	uuid	Yes	The UUID of the robot to delete.

Success Response

Code: 200 OK

{
  "message": "Robot deleted",
  "robot_id": "e7201eff-e29b-41d4-a716-446655440000",
  "robot_name": "SDK-Test-Bot-01-Edited",
  "robot_type": "spot"
}

Possible Errors

• RS-ROBOT-004: Robot ID not found.
• 401 Unauthorized: Invalid or missing API Key.

Sample Code (Python)

import requests

url = "[https://api.ridescan.ai/api/deleterobot](https://api.ridescan.ai/api/deleterobot)"
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": "YOUR_API_KEY"
}
payload = {
    "criteria": {
        "robot_id": "e7201eff-e29b-41d4-a716-446655440000"
    }
}

response = requests.delete(url, json=payload, headers=headers)
print(response.json())