POST
/
api
/
v1
/
rooms
curl --location --request POST 'https://api-prd.vidlab7.com/api/v1/rooms' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <YOUR_API_KEY>' \
--data-raw '{
    {
    "name": "My first room",
    "liveAvatarId": "123-abcd",
    "conversationShortCode": "abC123"
    "contactEmail": "name@example.com"
    "privacy": "private",
    "roomSettings": { "shouldBotJoinImmediately": false },
    "context": "My custom context"
}
}'
{
    "url": "https://vidlab7.daily.co/123aBc",
    "conversationId": "1234-abcde"
}

Headers

x-api-key
string
required
Your VidLab7 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.
roomSettings
object
The daily meeting room properties for the meeting room. Currently only supports the property “shouldBotJoinImmediately”, which is defaulted to false.
curl --location --request POST 'https://api-prd.vidlab7.com/api/v1/rooms' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <YOUR_API_KEY>' \
--data-raw '{
    {
    "name": "My first room",
    "liveAvatarId": "123-abcd",
    "conversationShortCode": "abC123"
    "contactEmail": "name@example.com"
    "privacy": "private",
    "roomSettings": { "shouldBotJoinImmediately": false },
    "context": "My custom context"
}
}'
{
    "url": "https://vidlab7.daily.co/123aBc",
    "conversationId": "1234-abcde"
}

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.