Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Subtitle → List Subtitles.

AI-generated

Summary

List all subtitles associated with a specified media item, supporting pagination, filtering by total count, and options to return either all items or a limited number of them.

Inputs

  • Authentication (required) — Choose between OAuth2 or API Key authentication methods to authorize the request.
  • Media (required) — Provide the unique identifier of the media item whose subtitles are to be listed.
  • Additional Query Parameters — Optionally specify query parameters including 'Return' to fetch total count instead of items, 'Page' to specify the page number, and 'Per Page' to set the number of subtitles per page.
  • Return All — Set to true (default) to return all subtitles for the given media; set to false to limit the number of results using the 'Limit' parameter.
  • Limit — Define the maximum number of subtitle items to return when 'Return All' is false; defaults to 50, with a minimum of 1 and maximum of 500.
  • Return Full Response — If enabled, returns the complete API response including metadata instead of just the list of subtitles.

Output shape

a list of subtitle objects, or if 'Return Full Response' is enabled, the full API response including subtitles and metadata; alternatively, a numeric total count if 'Return' parameter is set to 'total'.

Pagination applies using 'Page' and 'Per Page' query parameters when not returning all items. Use 'Return'='total' in additional query parameters to retrieve only the count of subtitles. The output depends on selected options and may be the raw response or extracted array of subtitles.

Examples

Example 1: Retrieve all subtitles for a media item with default pagination

Set 'Media' to the media unique ID, 'Return All' to true (default) to fetch all subtitles.

Example 2: Retrieve the total number of subtitles without the items

Set 'Media' to the media ID, add 'Return' parameter as 'total' in 'Additional Query Parameters'.

Example 3: Retrieve a limited set of subtitles

Set 'Media' to the media ID, 'Return All' to false, and specify 'Limit' to desired number.

Links

Discussion