Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Resources → Render Chapter.

AI-generated

Summary

Render a specific chapter of media content in a chosen format by specifying the media's unique identifier and the output format (json, xml, yaml, or vtt).

Inputs

  • Authentication — Selects the authentication method to access the Infomaniak API; options are OAuth2 or API Key. Defaults to OAuth2.
  • Media (required) — The unique identifier of the media whose chapter is to be rendered.
  • Format (required) — The desired output format of the rendered chapter. Valid values are 'json' (JavaScript Object Notation), 'xml' (Extensible Markup Language), 'yaml' (YAML Ain't Markup Language), or 'vtt' (Web Video Text Tracks subtitle format).
  • Return Full Response — Boolean option whether to return the full API response including headers and status code, or just the parsed body. Defaults to false.

Output shape

a single data payload containing the chapter rendering in the specified format or the full HTTP response if requested

The output shape depends on the 'Return Full Response' boolean input. If true, outputs the full HTTP response object; otherwise outputs only the parsed content of the rendering. Formats correspond to the requested output format and can be data structures (JSON, YAML), text/XML, or subtitle files (VTT). No pagination is involved.

Links

Discussion