Sign in
VideoV1Composition

List of all Recording compositions.

List of all Recording compositions.

get/v1/Compositions

Query parameters

Status'enqueued' | 'processing' | 'completed' | 'deleted' | 'failed'

The status of the composition. Can be: enqueued, processing, completed, deleted or failed. enqueued is the initial state and indicates that the composition request has been received and is scheduled for processing; processing indicates the composition is being processed; completed indicates the composition has been completed and is available for download; deleted means the composition media has been deleted from the system, but its metadata is still available for 30 days; failed indicates the composition failed to execute the media processing task.

Read only Composition resources with this status. Can be: enqueued, processing, completed, deleted, or failed.

DateCreatedAfterstring date-time

Read only Composition resources created on or after this ISO 8601 date-time with time zone.

DateCreatedBeforestring date-time

Read only Composition resources created before this ISO 8601 date-time with time zone.

RoomSidstring

Read only Composition resources with this Room SID.

PageSizeinteger

How many resources to return in each list page.

Pageinteger

The page index. This value is simply for client state.

PageTokenstring

The page token. This is provided by the API.

Response

OK

Changes

Changed in 7 of the 50 revisions of this API.57

  • v1207f8ef612391See the full diff
    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

  • v147b9aadf72282See the full diff
    • ▲

      for the query request parameter PageSize, default value 50 was added

      request-parameter-default-value-added

    • ▲

      for the query request parameter PageSize, the max was decreased from 1000.00 to 100.00

      request-parameter-max-decreased

  • v1ad992ed01a681See the full diff
    • ▲

      the // response's property type changed from no type to object for status

      response-property-type-changed

  • v11b9f69e2d5d01See the full diff
    • ▲

      for the query request parameter PageSize, the format changed from no format to int64

      request-parameter-type-changed

  • v1d1c4c2eb9f232See the full diff
    • ○

      the response's property default value 0 was added for the status

      response-property-default-value-added

    • ○

      the response's property default value 0 was added for the status

      response-property-default-value-added

  • v1d68da44b72424See the full diff
    • ○

      removed the DELETE enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the HEAD enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PATCH enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PUT enum value from the // response property for the response status

      response-property-enum-value-removed

  • v1987a2e6965981See the full diff
    • ○

      api tag VideoV1Composition added

      api-tag-added