Recordings

Start recording a meeting

Starts recording a meeting. The meeting can be started by an organization admin directly, or a participant with permissions to start a recording, based on the type of authorization used.

post/recordings

Request body

meeting_idstring uuid required

ID of the meeting to record.

max_secondsinteger

Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.

file_name_prefixstring

Update the recording file name.

urlstring uri

Pass a custom url to record arbitary screen

allow_multiple_recordingsboolean

By default, a meeting allows only one recording to run at a time. Enabling the allow_multiple_recordings parameter to true allows you to initiate multiple recordings concurrently in the same meeting. This allows you to record separate videos of the same meeting with different configurations, such as portrait mode or landscape mode.

Example request

{
  "storage_config": {
    "region": "us-east-1"
  },
  "video_config": {
    "width": 1280,
    "height": 720
  },
  "rtmp_out_config": {
    "rtmp_url": "rtmp://a.rtmp.youtube.com/live2"
  }
}

Response

Success response

successboolean required

Success status of the operation

Example response

{
  "data": {
    "storage_config": {
      "region": "us-east-1"
    },
    "start_reason": {
      "caller": {
        "user_Id": "d61f6956-e68f-4375-bf10-c38a704d1bec",
        "name": "Dyte_test"
      }
    },
    "stop_reason": {
      "caller": {
        "user_Id": "d61f6956-e68f-4375-bf10-c38a704d1bec",
        "name": "Dyte_test"
      }
    }
  }
}

Changes

Changed in 8 of the 50 revisions of this API.9626

Apr 4, 2025v2cb67ff854c7122See the full diff
- ▲
  the storage_config/auth_method request property type/format changed from / to string/
  request-property-type-changed
- ▲
  the allOf[subschema #2]/data/allOf[subschema #2]/storage_config/auth_method response's property type/format changed from / to string/ for status 200
  response-property-type-changed
- ○
  added the new optional request property rtmp_out_config
  new-optional-request-property
- ○
  added the new optional request property url
  new-optional-request-property
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 2, 2025v268b9e665bfcc22See the full diff
- ▲
  the storage_config/auth_method request property type/format changed from string/ to /
  request-property-type-changed
- ▲
  the allOf[subschema #2]/data/allOf[subschema #2]/storage_config/auth_method response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ●
  removed the request property rtmp_out_config
  request-property-removed
- ●
  removed the request property url
  request-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 19, 2024v2d8c5d90e84ac2See the full diff
- ▲
  the storage_config/auth_method request property type/format changed from / to string/
  request-property-type-changed
- ▲
  the allOf[subschema #2]/data/allOf[subschema #2]/storage_config/auth_method response's property type/format changed from / to string/ for status 200
  response-property-type-changed
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 7, 2024v25797e08991772See the full diff
- ○
  added the new optional request property audio_config/export_file
  new-optional-request-property
- ○
  added the new optional request property video_config/export_file
  new-optional-request-property
Oct 19, 2023v2cf0c52843ea61See the full diff
- ●
  added the new PAUSED enum value to the allOf[subschema #2]/data/allOf[subschema #1: Recording]/status response property for the response status 200
  response-property-enum-value-added
Sep 7, 2023v25a87f320c0773118See the full diff
- ▲
  the response property allOf[subschema #2]/data/allOf[subschema #2]/storage_config/bucket became optional for the status 200
  response-property-became-optional
- ▲
  the response property allOf[subschema #2]/data/allOf[subschema #2]/storage_config/region became optional for the status 200
  response-property-became-optional
- ▲
  the response property allOf[subschema #2]/data/allOf[subschema #2]/storage_config/secret became optional for the status 200
  response-property-became-optional
- ●
  added the new sftp enum value to the allOf[subschema #2]/data/allOf[subschema #2]/storage_config/type response property for the response status 200
  response-property-enum-value-added
- ○
  added the new optional request property storage_config/auth_method
  new-optional-request-property
- ○
  added the new optional request property storage_config/host
  new-optional-request-property
- ○
  added the new optional request property storage_config/password
  new-optional-request-property
- ○
  added the new optional request property storage_config/port
  new-optional-request-property
- ○
  added the new optional request property storage_config/private_key
  new-optional-request-property
- ○
  added the new optional request property storage_config/username
  new-optional-request-property
- ○
  the request property storage_config/access_key became optional
  request-property-became-optional
- ○
  the request property storage_config/bucket became optional
  request-property-became-optional
- ○
  the request property storage_config/region became optional
  request-property-became-optional
- ○
  the request property storage_config/secret became optional
  request-property-became-optional
- ○
  added the new sftp enum value to the request property storage_config/type
  request-property-enum-value-added
- ○
  added the optional property allOf[subschema #2]/data/allOf[subschema #2]/storage_config/auth_method to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/allOf[subschema #2]/storage_config/host to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/allOf[subschema #2]/storage_config/password to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/allOf[subschema #2]/storage_config/port to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/allOf[subschema #2]/storage_config/private_key to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/data/allOf[subschema #2]/storage_config/username to the response with the 200 status
  response-optional-property-added
- ○
  the response write-only property allOf[subschema #2]/data/allOf[subschema #2]/storage_config/access_key became optional for the status 200
  response-write-only-property-became-optional
Aug 29, 2023v27d1933aec9e012See the full diff
- ●
  removed the request property video_config/segment_length
  request-property-removed
- ○
  the height request property default value auto was removed
  request-property-default-value-removed
- ○
  the width request property default value 200 was removed
  request-property-default-value-removed
Aug 21, 2023v2011bc5f0225d12See the full diff
- ●
  removed the request property live_streaming_config
  request-property-removed
- ○
  added the new optional request property rtmp_out_config
  new-optional-request-property
- ○
  the enabled request property default value true was removed
  request-property-default-value-removed

Full history