Video API documentation

Jul 29, 2025

Change #f1cf3c2c

1.0.0

Breaking

Compare

32 structure changes including:

5 Additions

27 Modifications

Modified 27 Breaking

POST /v1/Rooms/{Sid}

Response
200 response Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
202 response Added

POST /v1/Rooms/{RoomSid}/RecordingRules

Response
202 response Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
200 response Added

POST /v1/Rooms/{RoomSid}/Participants/{Sid}

Response
200 response Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
202 response Added

POST /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules

Response
202 response Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
200 response Added

POST /v1/Rooms

Body
application/x-www-form-urlencoded content type Modified
- TranscribeParticipantsOnConnect, TranscriptionsConfiguration properties Added
Response
201 response Modified
- application/json content type Modified
  - status, type properties Modified
    - Type went from string | null to string
      Breaking
  - max_participants, max_participant_duration, empty_room_timeout, unused_room_timeout properties Modified
    - Type went from integer | null to integer
      Breaking

POST /v1/RecordingSettings/Default

Response
201 response Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
200 response Added

POST /v1/Compositions

Response
201 response Modified
- application/json content type Modified
  - status, format properties Modified
    - Type went from string | null to string
      Breaking
  - video_layout property Modified
    - Type is now object | null
  - bitrate, duration properties Modified
    - Type went from integer | null to integer
      Breaking

POST /v1/CompositionSettings/Default

Response
201 response Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
200 response Added

POST /v1/CompositionHooks/{Sid}

Response
200 response Modified
- application/json content type Modified
  - video_layout property Modified
    - Type is now object | null
  - format property Modified
    - Type went from string | null to string
      Breaking

POST /v1/CompositionHooks

Response
201 response Modified
- application/json content type Modified
  - video_layout property Modified
    - Type is now object | null
  - format property Modified
    - Type went from string | null to string
      Breaking

GET /v1/Rooms/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status, type properties Modified
    - Type went from string | null to string
      Breaking
  - max_participants, max_participant_duration, empty_room_timeout, unused_room_timeout properties Modified
    - Type went from integer | null to integer
      Breaking

GET /v1/Rooms/{RoomSid}/Recordings/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status, type, container_format, codec properties Modified
    - Type went from string | null to string
      Breaking
  - grouping_sids property Modified
    - Type is now object | null

GET /v1/Rooms/{RoomSid}/Recordings

Response
200 response Modified
- application/json content type Modified
  - recordings property Modified
    - status, type, container_format, codec properties Modified
      - Type went from string | null to string
        Breaking
    - grouping_sids property Modified
      - Type is now object | null
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Rooms/{RoomSid}/Participants/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status property Modified
    - Type went from string | null to string
      Breaking

GET /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks/{Sid}

Response
200 response Modified
- application/json content type Modified
  - kind property Modified
    - Type went from string | null to string
      Breaking

GET /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks

Response
200 response Modified
- application/json content type Modified
  - subscribed_tracks property Modified
    - kind property Modified
      - Type went from string | null to string
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules

Response
200 response Modified
- application/json content type Modified
  - rules property Modified
    - Type went from array[object(object)] | null to array[object(subscribe-rule)] | null
    - type, all, publisher, track, kind, priority properties Added

GET /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks/{Sid}

Response
200 response Modified
- application/json content type Modified
  - kind property Modified
    - Type went from string | null to string
      Breaking

GET /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks

Response
200 response Modified
- application/json content type Modified
  - published_tracks property Modified
    - kind property Modified
      - Type went from string | null to string
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Rooms/{RoomSid}/Participants

Response
200 response Modified
- application/json content type Modified
  - participants property Modified
    - status property Modified
      - Type went from string | null to string
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Rooms

Response
200 response Modified
- application/json content type Modified
  - rooms property Modified
    - status, type properties Modified
      - Type went from string | null to string
        Breaking
    - max_participants, max_participant_duration, empty_room_timeout, unused_room_timeout properties Modified
      - Type went from integer | null to integer
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Recordings/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status, type, container_format, codec properties Modified
    - Type went from string | null to string
      Breaking
  - grouping_sids property Modified
    - Type is now object | null

GET /v1/Recordings

Response
200 response Modified
- application/json content type Modified
  - recordings property Modified
    - status, type, container_format, codec properties Modified
      - Type went from string | null to string
        Breaking
    - grouping_sids property Modified
      - Type is now object | null
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Compositions/{Sid}

Response
200 response Modified
- application/json content type Modified
  - status, format properties Modified
    - Type went from string | null to string
      Breaking
  - video_layout property Modified
    - Type is now object | null
  - bitrate, duration properties Modified
    - Type went from integer | null to integer
      Breaking

GET /v1/Compositions

Response
200 response Modified
- application/json content type Modified
  - compositions property Modified
    - status, format properties Modified
      - Type went from string | null to string
        Breaking
    - video_layout property Modified
      - Type is now object | null
    - bitrate, duration properties Modified
      - Type went from integer | null to integer
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/CompositionHooks/{Sid}

Response
200 response Modified
- application/json content type Modified
  - video_layout property Modified
    - Type is now object | null
  - format property Modified
    - Type went from string | null to string
      Breaking

GET /v1/CompositionHooks

Response
200 response Modified
- application/json content type Modified
  - composition_hooks property Modified
    - video_layout property Modified
      - Type is now object | null
    - format property Modified
      - Type went from string | null to string
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

Added 5

POST /v1/Rooms/{RoomSid}/Transcriptions/{Ttid}

POST /v1/Rooms/{RoomSid}/Transcriptions

POST /v1/Rooms/{RoomSid}/Participants/{Sid}/Anonymize

GET /v1/Rooms/{RoomSid}/Transcriptions/{Ttid}

GET /v1/Rooms/{RoomSid}/Transcriptions

May 24, 2022

Change #fb4b7eb8

1.29.1

Breaking

Compare

17 structure changes including:

17 Modifications

Modified 17 Breaking

GET /v1/CompositionHooks

Response
200 response Modified
- composition_hooks property Modified

GET /v1/CompositionHooks/{Sid}

Response
200 response Modified
- video_layout property Modified

GET /v1/Compositions

Response
200 response Modified
- compositions property Modified

GET /v1/Compositions/{Sid}

Response
200 response Modified
- video_layout property Modified
- media_external_location, status_callback, status_callback_method properties Added

GET /v1/Recordings

Response
200 response Modified
- recordings property Modified

GET /v1/Recordings/{Sid}

Response
200 response Modified
- grouping_sids property Modified
- media_external_location, status_callback, status_callback_method properties Added

GET /v1/Rooms

Response
200 response Modified
- rooms property Modified

GET /v1/Rooms/{RoomSid}/Recordings

Response
200 response Modified
- recordings property Modified

GET /v1/Rooms/{RoomSid}/Recordings/{Sid}

Response
200 response Modified
- grouping_sids property Modified
- media_external_location property Added

GET /v1/Rooms/{Sid}

Response
200 response Modified
- audio_only, empty_room_timeout, large_room, max_participant_duration, unused_room_timeout properties Added

POST /v1/CompositionHooks

Body
content type Modified
- VideoLayout property Modified
Response
201 response Modified
- video_layout property Modified

POST /v1/CompositionHooks/{Sid}

Body
content type Modified
- VideoLayout property Modified
Response
200 response Modified
- video_layout property Modified

POST /v1/Compositions

Body
content type Modified
- VideoLayout property Modified
Response
201 response Modified
- video_layout property Modified
- media_external_location, status_callback, status_callback_method properties Added

POST /v1/Rooms

Body
content type Modified
- RecordingRules property Modified
- AudioOnly, EmptyRoomTimeout, LargeRoom, MaxParticipantDuration, UnusedRoomTimeout properties Added
Response
201 response Modified
- audio_only, empty_room_timeout, large_room, max_participant_duration, unused_room_timeout properties Added

POST /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules

Body
content type Modified
- Rules property Modified

POST /v1/Rooms/{RoomSid}/RecordingRules

Body
content type Modified
- Rules property Modified

POST /v1/Rooms/{Sid}

Response
200 response Modified
- audio_only, empty_room_timeout, large_room, max_participant_duration, unused_room_timeout properties Added

Apr 19, 2021

Change #bb1cc805

1.13.0

Compare

Do not miss any Video API changes, ever again

Changelog

API structure has changed

API structure has changed

API documentation has been created