Skip to main content
POST
meetings.room.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

Your own reference for the end user, 1 to 128 letters, digits, '_', '.' or '-'. Never an email or name.

Pattern: ^[A-Za-z0-9_.-]{1,128}$
app
string
required

The meeting app, lowercase, like "zoom", "googlemeet" or "microsoft_teams".

Pattern: ^[a-z0-9_-]{1,64}$
title
string
required

The meeting's title, 1 to 1,000 characters.

Required string length: 1 - 1000
start
string
required

Start time, ISO 8601, e.g. 2026-10-15T14:00:00Z or with an offset.

Maximum string length: 64
durationMinutes
number
required

Planned length in minutes, 1 to 1440.

Required range: 1 <= x <= 1440
timezone
string

IANA time zone for display, e.g. America/New_York.

Required string length: 1 - 64
waitingRoom
boolean

Put guests in a waiting room until the host admits them.

recording
enum<string>

cloud records to the app's storage, local on the host's machine, none (default) does not record.

Available options:
cloud,
local,
none

Response

The result

joinUrl
string
required

The guest link: anyone with it can join as a guest.

title
string

The meeting's title.

status
enum<string>

scheduled, started or ended, when the app reports it.

Available options:
scheduled,
started,
ended
startsAt
string

Start time, ISO 8601.

durationMinutes
number

Planned length in minutes.

timezone
string

IANA time zone, e.g. America/New_York.

waitingRoom
boolean

Whether guests wait for the host to admit them.

recording
enum<string>

Where a recording is kept: cloud, local to the host, or none.

Available options:
cloud,
local,
none
hostUrl
string

The host link, where the app gives a separate one. Returned only on a connection that may write, never on a read-only one. Sensitive: keep it private; it can start the meeting as host.

dialIn
string

Dial-in details, where the app gives them.

ref
string

Reference to what this call created. Pass it as ref to meetings.room.get, meetings.room.delete, meetings.recordings.list.