Sign in

v1

latestOpenAPI 3.0.32026-07-13401683.8 KB
Segments

Returns the segments matching the query parameters.

get/api/v2/segments

Query parameters

episodeIdinteger required

The ID of the episode that owns the segment.

segmentNumberinteger
pageStartinteger

The start page of the results to return. The first item is indexed at 0.

pageSizeinteger

The number of items to return. Must be between 0 and 500, inclusive.

orderById'asc' | 'desc'

The sort order of the list of segments, based on segment ID. If unspecified, the segments are returned in random order. If using paging to iterate through the results, sort order should be specified.

Response

The segments matching the query parameters

idinteger

The unique ID of the segment. Generated at creation.

episodeIdinteger required

The ID of the episode that owns the segment.

segmentNumberinteger required

The number of the segment in the episode, starting with 1.

inCuestring

The in-cue copy that signals the start of the segment to a board operator.

outCuestring

The out-cue copy that signals the end of the segment to a board operator.

createdDatestring date-time

The date the segment was created in ISO 8601 format. Generated at creation.

lastModifiedDatestring date-time

The date the segment was last modified/updated in ISO 8601 format. Automatically updated on any write operation.

lengthinteger

The length (duration) of the segment in seconds.

channelsinteger

The number of audio channels in the segment. Generated at creation.

fileSizeinteger

The size of the audio content file in bytes. Generated at creation.

fileNamestring

The name of the audio content file. Generated at creation.

originalFileNamestring

The original name of the audio content file.