Create meeting room

Establishes a live meeting room featuring an AI assistant, accessible to a single participant. Upon joining, the user may engage in a timed conversation with the assistant.

POST /api/v1/rooms

Example Request

curl --location --request POST 'https://api-prd.moonscale.com/api/v1/rooms' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <YOUR_API_KEY>' \
--data-raw '{
    {
    "name": "room-name",
    "liveAvatarId": "avatar-uuid",
    "conversationShortCode": "conversation-shortcode"
    "contactEmail": "[e-mail]"
    "privacy": "private",
    "enableChat": true,
    "roomSettings": { "shouldBotJoinImmediately": false },
    "context": "context"
}
}'

Response

{
    "url": "https://your-daily-room-url",
    "conversationId": "conversation-id"
}

Headers

x-api-key · string · required

Your Moonscale API key used for authentication.

Content-Type · string

The content type of the request body. Always application/json.

Body ^{application/json}

liveAvatarId · string · required

The UUID of the LiveAvatar that should be used for the meeting as a string.

conversationShortCode · string

The conversationShortCode for the liveAvatar that should be used for the meeting as a string. If there is no current conversation history with this avatar, leave it blank.

contactEmail · string

The contact email that will be used for the current meeting.

privacy · string

The privacy setting of the meeting room, a string value of either public or private.

enableChat · boolean

The enable chat setting for the room, which opens the chat up by default once the call starts, a boolean value that is defaulted to true.

roomSettings · object

The daily meeting room properties for the meeting room. Currently only supports the property “shouldBotJoinImmediately”, which is defaulted to false.

Example Request

curl --location --request POST 'https://api-prd.moonscale.com/api/v1/rooms' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <YOUR_API_KEY>' \
--data-raw '{
    {
    "name": "room-name",
    "liveAvatarId": "avatar-uuid",
    "conversationShortCode": "conversation-shortcode"
    "contactEmail": "[e-mail]"
    "privacy": "private",
    "enableChat": true,
    "roomSettings": { "shouldBotJoinImmediately": false },
    "context": "context"
}
}'

Response

{
    "url": "https://your-daily-room-url",
    "conversationId": "conversation-id"
}

Responses

---

201:

url · string

The URL for the meeting room with token attached to it for entry by the client.

conversationId · string

The conversation id (UUID) for the meeting room used to retrieve the transcripts as a string.