Skip to main content
POST
/
rooms
Create Room
curl --request POST \
  --url https://api.example.com/rooms \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "waitingRoom": true,
  "maxParticipants": 123
}
'
{
  "400": {},
  "401": {},
  "500": {},
  "id": "<string>",
  "code": "<string>",
  "name": "<string>",
  "hostId": "<string>",
  "isActive": true,
  "isLocked": true,
  "startedAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "host": {
    "id": "<string>",
    "displayName": "<string>",
    "avatarUrl": "<string>"
  },
  "settings": {
    "id": "<string>",
    "roomId": "<string>",
    "allowChat": true,
    "allowScreenShare": true,
    "allowGuestAccess": true,
    "waitingRoom": true,
    "muteParticipantsOnJoin": true,
    "maxParticipants": 123
  }
}
Create a new meeting room with a unique room code. Authentication is required.

​
Authentication

This endpoint requires JWT authentication. Include the Bearer token in the Authorization header.

​
Request Body

​
name
string
The name of the meeting room. Defaults to “Meeting Room” if not provided.
  • Minimum length: 1
  • Maximum length: 100
​
waitingRoom
boolean
default:false
Enable waiting room for participants. When enabled, participants must wait for host approval before joining.
​
maxParticipants
integer
default:50
Maximum number of participants allowed in the room.
  • Minimum: 2
  • Maximum: 100

​
Response

Returns the created room object with settings and host information.
​
id
string
required
Unique identifier for the room
​
code
string
required
Unique room code in format xxx-xxx-xxx (e.g., “abc-def-ghi”)
​
name
string
required
Name of the room
​
hostId
string
required
ID of the user who created the room
​
isActive
boolean
required
Whether the room is currently active
​
isLocked
boolean
required
Whether the room is locked (prevents new participants from joining)
​
startedAt
string
required
ISO 8601 timestamp when the room was started
​
createdAt
string
required
ISO 8601 timestamp when the room was created
​
updatedAt
string
required
ISO 8601 timestamp when the room was last updated
​
host
object
required
Information about the room host
​
id
string
required
Host user ID
​
displayName
string
required
Host display name
​
avatarUrl
string
URL to host’s avatar image
​
settings
object
required
Room settings configuration
​
id
string
required
Settings ID
​
roomId
string
required
Associated room ID
​
allowChat
boolean
required
Whether chat is enabled (default: true)
​
allowScreenShare
boolean
required
Whether screen sharing is allowed (default: true)
​
allowGuestAccess
boolean
required
Whether guests can join without authentication (default: true)
​
waitingRoom
boolean
required
Whether waiting room is enabled (default: false)
​
muteParticipantsOnJoin
boolean
required
Whether participants are muted when they join (default: false)
​
maxParticipants
integer
required
Maximum number of participants allowed (default: 100)

​
Example Request

curl -X POST https://api.neuronmeet.com/rooms \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Team Standup",
    "waitingRoom": true,
    "maxParticipants": 10
  }'

​
Example Response

{
  "id": "clx1a2b3c4d5e6f7g8h9i0j",
  "code": "abc-def-ghi",
  "name": "Team Standup",
  "hostId": "clx0a1b2c3d4e5f6g7h8i9j",
  "isActive": true,
  "isLocked": false,
  "startedAt": "2026-03-03T10:30:00.000Z",
  "createdAt": "2026-03-03T10:30:00.000Z",
  "updatedAt": "2026-03-03T10:30:00.000Z",
  "host": {
    "id": "clx0a1b2c3d4e5f6g7h8i9j",
    "displayName": "John Doe",
    "avatarUrl": "https://example.com/avatar.jpg"
  },
  "settings": {
    "id": "clx2a3b4c5d6e7f8g9h0i1j",
    "roomId": "clx1a2b3c4d5e6f7g8h9i0j",
    "allowChat": true,
    "allowScreenShare": true,
    "allowGuestAccess": true,
    "waitingRoom": true,
    "muteParticipantsOnJoin": false,
    "maxParticipants": 10
  }
}

​
Error Codes

​
400
error
Bad Request - Failed to generate unique room code after 10 attempts, or validation errors in request body
​
401
error
Unauthorized - Missing or invalid JWT token
​
500
error
Internal Server Error - Server error while creating the room

Build docs developers (and LLMs) love

Get started for freeTalk to us