Account and API keys

You need an account for everything. You need an API key only when something outside the dashboard talks to Cyberwave: an AI coding tool, the Python SDK, the CLI or your own HTTP client.

Create an account

Sign up, verify your email, and create or join a workspace. The dashboard, the built-in agents and the Playground need nothing else.

Create an API key

Open Profile → Access

Go to Profile → Access and select Create Token.

Scope it to one workspace

Name the key (for example, Quickstart) and select one workspace. A key that covers several workspaces makes every request name one, or it fails with 400 workspace_required.

Copy it now

The key is shown once. If you miss it, create a new one.

Never commit a key or paste it into a shared chat. Keep it in an environment variable or your client’s secret settings.

Use your key

Terminal
Python SDK
MCP client
REST API

Paste the key at a hidden prompt, so it stays out of your shell history:

printf 'Cyberwave API key: '
read -rs CYBERWAVE_API_KEY
printf '\n'
export CYBERWAVE_API_KEY

The SDK reads CYBERWAVE_API_KEY from the environment:

from cyberwave import Cyberwave

cw = Cyberwave()

Cyberwave(api_key="...") also works. Avoid it in code you share.

Send the key as Authorization: Bearer <key> to https://mcp.cyberwave.com/mcp. See Connect your AI tool.

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

Environment variables

Variable	Use
`CYBERWAVE_API_KEY`	Your API key. Required.
`CYBERWAVE_WORKSPACE_ID`	Workspace UUID. Needed when the key covers several workspaces.
`CYBERWAVE_ENVIRONMENT_ID`	Default environment UUID. Skips auto-creating a Quickstart Environment.
`CYBERWAVE_BASE_URL`	API base URL. Default `https://api.cyberwave.com`.
`CYBERWAVE_MQTT_HOST` / `CYBERWAVE_MQTT_PORT`	MQTT broker. Default `mqtt.cyberwave.com`, port `8883` with TLS.

If something fails

Error	Fix
`No API key found`	Export `CYBERWAVE_API_KEY` in the terminal that runs your code.
`401` / `AUTH_ERROR`	The key is wrong or revoked. Create a new one.
`400 workspace_required`	Set `CYBERWAVE_WORKSPACE_ID`, or use a key scoped to one workspace.
`403`	Check your role in the workspace and the key’s scope.
MQTT connection failed	Allow outbound TCP 8883. See Network and firewall.

Get started

Build with AI

Simulate & test

Connect hardware

Train & improve

Deploy & operate

Create an account

Create an API key

Use your key

Environment variables

If something fails

Go deeper

API tokens

Credits and billing

​Create an account

​Create an API key

​Use your key

​Environment variables

​If something fails

​Go deeper

API tokens

Credits and billing

Create an account

Create an API key

Use your key

Environment variables

If something fails

Go deeper