API Overview - Cyberwave Docs

Introduction

Cyberwave provides two main APIs to interact with the platform, each designed for specific use cases and communication patterns.

REST API

The REST API is used for non-real-time communication with the Cyberwave platform. It follows standard HTTP methods and is ideal for:

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

Authentication

All REST endpoints require an API key. Go to the Cyberwave dashboard → API Tokens card → Create Token, then pass the key in the Authorization header on every request.

Field	Value
Base URL	`https://api.cyberwave.com`
Auth header	`Authorization: Bearer <CYBERWAVE_API_KEY>`
Accepted prefixes	`Bearer` and `Token` (case-insensitive)
OpenAPI security scheme	`CustomTokenAuthentication` (API key, header)
Recommended env var	`CYBERWAVE_API_KEY`
Where to get a key	`https://app.cyberwave.com/profile` → API Tokens card → Create Token

curl
Python (requests)
JavaScript (fetch)

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();

Treat the API key like a password. Never commit it to source control or paste it into client-side code that ships to browsers. Prefer environment variables and short-lived keys for production deployments.

MQTT API

The MQTT API is used for real-time communication with robots and telemetry data. This lightweight, publish-subscribe protocol is perfect for:

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

Choosing the Right API

Use Case	Recommended API
Fetch robot configuration	REST
Send real-time commands to robots	MQTT
Query historical telemetry	REST
Stream live sensor data	MQTT
Manage user permissions	REST
Receive instant event notifications	MQTT

Getting Started

To start using the Cyberwave APIs, make sure you have:

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

REST API Reference

Browse every REST endpoint, request schema, and response shape.

MQTT API Reference

Connect to MQTT and start streaming real-time data.

​Introduction

​REST API

​Authentication

​MQTT API

​Choosing the Right API

​Getting Started

REST API Reference

MQTT API Reference

Introduction

REST API

Authentication

MQTT API

Choosing the Right API

Getting Started