Mission Management

Missions are containers for telemetry data associated with a specific robot. These endpoints allow you to create, retrieve, update, and delete missions.

Create Mission

Initializes a new mission associated with a specific robot.

• Endpoint: /api/createmission
• 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_id	uuid	Yes	The UUID of the parent robot.
params.mission_name	string	Yes	Name of the mission (e.g., “SDK-Readme-Mission-01”).

Success Response

Code: 200 OK

{
  "calibration_possible": false,
  "created_time": "2026-01-07T10:00:00",
  "inference_possible": false,
  "message": "Mission created",
  "mission_id": "9384ac10-e29b-41d4-a716-446655440000",
  "mission_name": "SDK-Readme-Mission-01",
  "modified_time": "2026-01-07T10:00:00",
  "robot_id": "e7201eff-e29b-41d4-a716-446655440000"
}

Possible Errors

• RS-MSN-001: Mission name conflict (a mission with this name already exists for this robot).
• 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/createmission](https://api.ridescan.ai/api/createmission)"
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": "YOUR_API_KEY"
}
payload = {
    "params": {
        "robot_id": "e7201eff-e29b-41d4-a716-446655440000",
        "mission_name": "SDK-Readme-Mission-01"
    }
}

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

---

Get Missions

Retrieves mission details based on various filters.

• Endpoint: /api/getmission
• 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.

Parameter	Type	Required	Description
criteria.robot_id	uuid	No	Filter missions by Robot UUID.
criteria.mission_id	uuid	No	Filter by specific Mission UUID.
criteria.mission_name	string	No	Search by mission name.
criteria.start_time	string	No	Filter by start timestamp (ISO 8601).
criteria.end_time	string	No	Filter by end timestamp (ISO 8601).

Success Response

Code: 200 OK

[
  {
    "calibration_possible": false,
    "created_time": "2026-01-07T10:00:00",
    "inference_possible": false,
    "mission_id": "9384ac10-e29b-41d4-a716-446655440000",
    "mission_name": "SDK-Readme-Mission-01",
    "modified_time": "2026-01-07T10:00:00",
    "robot_id": "e7201eff-e29b-41d4-a716-446655440000",
    "robot_name": "SDK-Test-Bot-01-Edited",
    "robot_type": "spot"
  }
]

Possible Errors

• RS-MSN-002: Mission ID not found.
• 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/getmission](https://api.ridescan.ai/api/getmission)"
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": "YOUR_API_KEY"
}
payload = {
    "criteria": {
        "robot_id": "e7201eff-e29b-41d4-a716-446655440000"
    }
}

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

---

Edit Mission

Renames an existing mission.

• Endpoint: /api/editmission
• Method: PATCH

Request Headers

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

Request Body

This endpoint requires both criteria (to identify the mission) and params (for the new values).

Parameter	Type	Required	Description
criteria.robot_id	uuid	Yes	The parent robot UUID.
criteria.mission_id	uuid	Yes	The mission UUID to update.
params.mission_name	string	Yes	New name for the mission.

Success Response

Code: 200 OK

{
  "calibration_possible": false,
  "created_time": "2026-01-07T10:00:00",
  "inference_possible": false,
  "message": "Mission edited",
  "mission_id": "9384ac10-e29b-41d4-a716-446655440000",
  "mission_name": "SDK-Readme-Mission-01-v2",
  "modified_time": "2026-01-07T12:00:00",
  "robot_id": "e7201eff-e29b-41d4-a716-446655440000"
}

Possible Errors

• RS-MSN-002: Mission ID not found.
• RS-ROBOT-004: Robot ID not found.
• RS-MSN-001: Mission name conflict.
• 401 Unauthorized: Invalid or missing API Key.

Sample Code (Python)

import requests

url = "[https://api.ridescan.ai/api/editmission](https://api.ridescan.ai/api/editmission)"
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": "YOUR_API_KEY"
}
payload = {
    "criteria": {
        "robot_id": "e7201eff-e29b-41d4-a716-446655440000",
        "mission_id": "9384ac10-e29b-41d4-a716-446655440000"
    },
    "params": {
        "mission_name": "SDK-Readme-Mission-01-v2"
    }
}

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

---

Delete Mission

Permanently removes a mission record.

• Endpoint: /api/deletemission
• 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 mission to delete.

Parameter	Type	Required	Description
criteria.robot_id	uuid	Yes	The parent robot UUID.
criteria.mission_id	uuid	Yes	The mission UUID to delete.

Success Response

Code: 200 OK

{
  "message": "Mission deleted",
  "mission_id": "9384ac10-e29b-41d4-a716-446655440000",
  "mission_name": "SDK-Readme-Mission-01-v2",
  "robot_id": "e7201eff-e29b-41d4-a716-446655440000"
}

Possible Errors

• RS-MSN-002: Mission ID not found.
• 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/deletemission](https://api.ridescan.ai/api/deletemission)"
headers = {
    "Content-Type": "application/json",
    "X-API-KEY": "YOUR_API_KEY"
}
payload = {
    "criteria": {
        "robot_id": "e7201eff-e29b-41d4-a716-446655440000",
        "mission_id": "9384ac10-e29b-41d4-a716-446655440000"
    }
}

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