Authentication

Overview

Cyberwave uses API tokens to authenticate requests. You’ll need a token to:

Connect the Python SDK
Make REST API calls
Establish MQTT connections

Each token is scoped to a specific workspace, giving you isolated access per workspace.

Creating an API Token

Go to cyberwave.com and sign in to your account.

Navigate to Profile

Click your profile icon and select Profile or go directly to cyberwave.com/profile.

Create a Token

Open Access (Profile → Access) and click Create Token. Select the workspace you want the token scoped to, then copy the token immediately — it won’t be shown again.

Keep your API token secure. Don’t commit it to version control or share it publicly.

Using Your API Token

Environment Variable (Recommended)

Set your API token as an environment variable:

export CYBERWAVE_API_KEY="cw_your_token_here"

The SDK automatically reads this variable:

import cyberwave as cw

# Automatically uses CYBERWAVE_API_KEY
robot = cw.twin("the-robot-studio/so101")

Direct Configuration

Pass the API token directly when initializing the client:

from cyberwave import Cyberwave

client = Cyberwave(api_key="cw_your_token_here")

Environment Variables

The SDK supports these environment variables:

Variable	Description
`CYBERWAVE_API_KEY`	Your API token for authentication
`CYBERWAVE_BASE_URL`	API base URL (default: `https://api.cyberwave.com`)
`CYBERWAVE_ENVIRONMENT_ID`	Default environment UUID
`CYBERWAVE_WORKSPACE_ID`	Default workspace UUID
`CYBERWAVE_MQTT_HOST`	MQTT broker host (default: `mqtt.cyberwave.com`)
`CYBERWAVE_MQTT_PORT`	MQTT broker port (default: `8883`)

Example `.env` File

CYBERWAVE_API_KEY=cw_a1b2c3d4e5f6...
CYBERWAVE_ENVIRONMENT_ID=1e48b1a5-ff2b-45ba-a854-a2c2df561852

Load with python-dotenv:

from dotenv import load_dotenv
load_dotenv()

import cyberwave as cw
robot = cw.twin("the-robot-studio/so101")

MQTT Authentication

For real-time features (video streaming, teleoperation, live joint updates), the SDK connects to MQTT automatically using your API token. The MQTT connection is lazily initialized — it connects on the first call that requires it (e.g., subscribing to joint updates).

from cyberwave import Cyberwave

client = Cyberwave(api_key="cw_your_token_here")

robot = client.twin("the-robot-studio/so101")
# MQTT connects automatically on the first subscription
robot.subscribe_joints(lambda data: print(f"Joints: {data}"))

The default MQTT connection uses TLS on port 8883.

Custom MQTT Settings

Override MQTT connection settings if needed:

client = Cyberwave(
    api_key="cw_your_token_here",
    mqtt_host="mqtt.cyberwave.com",
    mqtt_port=8883
)

REST API Authentication

For direct REST API calls, include your API token in the Authorization header:

curl -X GET "https://api.cyberwave.com/api/v1/assets/" \
  -H "Authorization: Bearer cw_your_token_here"

Both Bearer and Token prefixes are accepted.

Troubleshooting

Authentication failed: Invalid or missing credentials

Verify your API token is correct and hasn’t been revoked.
Check that the environment variable is set: echo $CYBERWAVE_API_KEY.
Create a new token under Profile → Access if needed. See API tokens.

No API key found! Set CYBERWAVE_API_KEY.

The SDK couldn’t find credentials. Either:

Set the CYBERWAVE_API_KEY environment variable.
Pass api_key directly to Cyberwave().

MQTT connection failed

Check that your network allows outbound connections on port 8883 (TLS).
Verify your API token is valid and not revoked.
The MQTT client connects lazily. Call a subscription method to trigger the connection.

Connectivity Requirements for Running an Edge

If you’re running the Cyberwave Edge runtime (Edge Core plus drivers) on your own hardware, here’s every connection it needs. All of these are outbound-initiated from the edge — you generally don’t need to open any inbound ports on your network.

Purpose	Protocol / Port	Destination	Required when
REST API	TCP `443` (HTTPS)	`api.cyberwave.com`	Always
MQTT (telemetry, commands, WebRTC signaling)	TCP `8883` (MQTT over TLS)	`mqtt.cyberwave.com`	Always
TURN relay over TLS (default)	TCP `443`	`tls.turn.cyberwave.com`	Streaming video
STUN	UDP `3478`	`turn.cyberwave.com`	Streaming video (optional; the TLS relay connects without it)
Zenoh peer discovery	UDP multicast, local subnet only	Local network	Running more than one driver/worker process on the edge
Zenoh router (multi-host)	TCP `7447`	Between edge hosts on your site	Only if drivers are split across multiple hosts on the same site

For the full picture of why each protocol is used, see Architecture → Video Streaming (WebRTC) and Architecture → Local Data Bus (Zenoh).

Get started

AI agents

AI models

Control

Learn

Run on edge or cloud

Platform

For integrators

Help

Overview

Creating an API Token

Using Your API Token

Environment Variable (Recommended)

Direct Configuration

Environment Variables

Example `.env` File

MQTT Authentication

Custom MQTT Settings

REST API Authentication

Troubleshooting

Connectivity Requirements for Running an Edge

Next Steps

Develop in simulation

Python SDK

​Overview

​Creating an API Token

​Using Your API Token

​Environment Variable (Recommended)

​Direct Configuration

​Environment Variables

​Example .env File

​MQTT Authentication

​Custom MQTT Settings

​REST API Authentication

​Troubleshooting

​Connectivity Requirements for Running an Edge

​Next Steps

Develop in simulation

Python SDK

Overview

Creating an API Token

Using Your API Token

Environment Variable (Recommended)

Direct Configuration

Environment Variables

Example `.env` File

MQTT Authentication

Custom MQTT Settings

REST API Authentication

Troubleshooting

Connectivity Requirements for Running an Edge

Next Steps