Sign in

v1

latestOpenAPI 3.0.32026-07-13401683.8 KB
Pieces

Returns the pieces matching the query parameters.

get/api/v2/pieces

Query parameters

episodeIdinteger required

The ID of the episode that owns the piece.

Response

The pieces matching the query parameters

idinteger

The unique ID of the piece. Generated at creation.

episodeIdinteger required

The ID of the episode that owns the piece.

segmentNumberinteger

The number of the segment that this piece is in, starting with 1. This is an optional field but it can be used to provide more detail by linking the piece to a specific audio segment.

createdDatestring date-time

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

lastModifiedDatestring date-time

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

titlestring required

The human readable title of the piece that is normally displayed on an end user's device.

relativeStartTimeinteger required

Seconds relative to the start of the episode.

relativeEndTimeinteger required

Seconds relative to the start of the episode.

descriptionstring

The short description of the piece.

fullDescriptionstring

The long description of the piece.

imageFileSizeinteger

The size of the piece image file in bytes. Generated at creation.

imageFileNamestring

The name of the piece image file. Generated at creation.

imageOriginalFileNamestring

The user's original name of the piece image file.

imageCdDriveUristring

The URI to the piece image content in CD Drive. Format should be 'cddrive:id:{value}' or 'cddrive://{path}'. This property is only used on modification and is not returned.