API Overview

Documentation Index

Fetch the complete documentation index at: https://docs.cyberwave.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Introduction

​

REST API

• Creating and managing digital twins
• Configuring robot settings
• Retrieving historical data
• Managing user accounts and permissions
• Performing administrative tasks

​

Authentication

export CYBERWAVE_API_KEY="cw_your_token_here"

curl -X GET "https://api.cyberwave.com/api/v1/projects" \
  -H "Authorization: Bearer $CYBERWAVE_API_KEY"

import os
import requests

headers = {
    "Authorization": f"Bearer {os.environ['CYBERWAVE_API_KEY']}",
}

r = requests.get("https://api.cyberwave.com/api/v1/projects", headers=headers)
r.raise_for_status()
print(r.json())

const res = await fetch("https://api.cyberwave.com/api/v1/projects", {
  headers: {
    Authorization: `Bearer ${process.env.CYBERWAVE_API_KEY}`,
  },
});

if (!res.ok) throw new Error(`${res.status} ${res.statusText}`);
const data = await res.json();

​

MQTT API

• Live robot control and commands
• Real-time telemetry streaming
• Sensor data collection
• Event notifications
• Low-latency bidirectional communication

​

Choosing the Right API

​

Getting Started

1. A valid API key or authentication credentials
2. The appropriate SDK installed (optional but recommended)
3. Network access to the Cyberwave platform