Create Meeting/SDK Room API
The Huddle01 API provides the ability to create rooms for hosting various communication experiences. In order to use the API, you will need to obtain an API key by connecting to your wallet.
Endpoint
POST
https://api.huddle01.com/api/v1/create-room
The Create Room API is to create a meeting room and obtain roomId.
Additionally, you can add custom functionalities such as muteOnEntry,
roomLock, and hostWallets, among others, to enhance the functionality of
your meeting rooms.
POST
/createroom
Create Meeting/SDK Room Api
The API supports a POST request with the following required parameters:
title- The title of the room.hostWallets- An array of Ethereum addresses of the room hosts.
Request
POST • /create-room
const response = await axios.post(
'https://api.huddle01.com/api/v1/create-room',
{
title: 'Huddle01-Test',
hostWallets: ['0x29f54719E88332e70550cf8737293436E9d7b10b'],
},
{
headers: {
'Content-Type': 'application/json',
'x-api-key': {{API_KEY}},
},
}
);Response
Upon success, the API will return a response with the following fields:
message- The message returned from the server.roomId- The id of the room created.
In case of an error, the API will return an error message with a corresponding status code.
Response
{
"message": "Meeting Created Successfully",
"data": {
"roomId": "tyt-eyoq-zwq",
"meetingLink": "https://app.huddle01.com/tyt-eyoq-zwq"
}
}Request
| Params | Definition | Data Type | Mandatory |
|---|---|---|---|
| title | The title of the room. This will be displayed in the room list. | string | Y |
| description | The description of the room. This will be displayed in the room list. | string | N |
| roomType | AUDIO will be for Audio Spaces and VIDEO will be for normal meetings with Video and Audio both. | AUDIO | VIDEO | N |
| startTime | The start time of the room. This will be displayed in the room list. | string (ISO 8601) | N |
| expiryTime | The expiry time of the room. This will be displayed in the room list. | string (ISO 8601) | N |
| hostWallets | The host wallets how who will have admin access to the room. | string [ ] | N |
| roomLocked | The start time of the room. This will be displayed in the room list. | boolean | true |
| muteOnEntry | Every new peer who joins, must be muted | boolean | false |
| videoOnEntry | Every new peer who joins, must have their video turned off | boolean | false |
Response
| Fields | Definition | Data Type |
|---|---|---|
| message | The message returned from the server. | string |
| roomId | The id of the room created. | string |