API Documentation

Integrate spatial audio rooms, sync real-time user statuses, and trigger culture recognition events directly from your own applications.

Introduction

The Nexus API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL for all V1 API requests: https://api.nexus.app/v1

Authentication

The Nexus API uses API keys to authenticate requests. You can view and manage your API keys in the Nexus Dashboard under Developer Settings.

Authentication to the API is performed via HTTP Bearer Auth. Provide your API key as the bearer token value in the Authorization header.

Request Example

curl https://api.nexus.app/v1/users/me \
  -H "Authorization: Bearer nx_live_8a9b7c6d5e4f3g2h1i"

Audio Rooms

Audio rooms are the core spatial environments where your team interacts. You can programmatically create, manage, and fetch the status of these rooms.

GET /v1/rooms

Returns a list of all active audio rooms in your workspace, including current participant counts.

Response - 200 OK

{
  "object": "list",
  "data": [
    {
      "id": "room_a1b2c3",
      "name": "Design Sync",
      "type": "proximity",
      "active_participants": 4,
      "is_locked": false
    },
    {
      "id": "room_x9y8z7",
      "name": "Watercooler",
      "type": "global",
      "active_participants": 12,
      "is_locked": false
    }
  ],
  "has_more": false
}

POST /v1/rooms/invite

Sends a direct dashboard and Slack notification inviting a specific user to an active room.

Request Body

{
  "room_id": "room_a1b2c3",
  "user_id": "usr_7d8e9f",
  "message": "Hey Sarah, can you jump in to review this Figma file?"
}

Webhooks

Webhooks allow you to build or set up integrations that subscribe to certain events on Nexus. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL.

Popular Events

user.status.changed Triggers when a user goes 'Heads Down' or 'Available'
recognition.created Triggers when a user sends points to a colleague
game.lobby.opened Triggers when a new synchronous game is starting