Skip to main content
POST
/
api
/
run
/
meetings
/
lifecycle
/
startMeeting
startMeeting
curl --request POST \
  --url https://connvo-dev.convex.cloud/api/run/meetings/lifecycle/startMeeting \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "args": {
    "meetingId": "meeting_123example"
  }
}'
{
  "status": "success",
  "errorMessage": "",
  "errorData": {},
  "value": {
    "success": true,
    "webrtcReady": true,
    "videoProvider": "webrtc",
    "roomInfo": {
      "iceServers": [
        {
          "urls": "stun:stun.l.google.com:19302"
        },
        {
          "urls": "stun:stun1.l.google.com:19302"
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Standard user authentication token issued via WorkOS. Provide as Authorization: Bearer <user-token>.

Body

application/json
args
object
required

Response

Convex executed your request and returned a result

status
enum<string>
required
Available options:
success,
error
errorMessage
string
errorData
object
value
object