Skip to main content
POST
/
api
/
run
/
meetings
/
stream
/
index
/
startRecording
startRecording
curl --request POST \
  --url https://connvo-dev.convex.cloud/api/run/meetings/stream/index/startRecording \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "args": {
    "meetingId": "meeting_123example",
    "recordingConfig": {
      "mode": "available",
      "audioOnly": false,
      "quality": "720p",
      "layout": "grid"
    }
  }
}
'
{
  "status": "success",
  "errorMessage": "",
  "errorData": {},
  "value": {
    "recordingId": "recording_1704067200000",
    "recordingUrl": "https://stream-recordings.example.com/recording_1704067200000.mp4",
    "success": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.connvo.app/llms.txt

Use this file to discover all available pages before exploring further.

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