API Documentation

Appearance

GET /playlists ​

Description ​

The Playlists resource allows you to obtain a HLS or MPEG DASH playlist for any file encoded in MP4 format or any job with outputs in MP4 format. If you request the playlist for a job ID with multiple outputs in MP4 format, you will receive a playlist including each of the outputs as a representation (e.g. different resolutions or different bitrates).

Endpoints ​

  • GET /playlists/hls.m3u8: Allows obtaining a HLS playlist of one or more file(s) encoded in MP4 format by a successfully finished conversion Job.
  • GET /playlists/dash.mpd: Allows obtaining a MPEG DASH playlist of one or more file(s) encoded in MP4 format by a successfully finished conversion Job.

Authentication ​

  • Optional: Bearer token or HMAC signature

Headers ​

  • Authorization: Bearer [AUTH_TOKEN] (if provided)

Parameters ​

Query Parameters ​

  • file_id: string (Optional)
    ID specifying one or more file(s) in the Files resource. Multiple file IDs can be provided separated by commas.
  • job_id: string (Optional)
    Shortcut for selecting all the output file IDs of a given job. Equivalent to listing all output file IDs of a job comma-separated in the "file_id" parameter. The "file_id" and "job_id" parameters should not be used together.
  • autograph_tag: string (Optional)
    A unique tag to be embedded dynamically with the resulting video stream for traceability via Xvid AutoGraph watermarking technology.
  • expiry_time: int (Optional)
    Desired expiry time (in seconds since epoch) for the playlist.
  • anti_fraud: boolean (Optional)
    Enables features to prevent link sharing and detect fraud.
  • ip: int (Optional)
    Allows only clients with the specified IP address to retrieve the playlist. The IP must be specified as a 32-bit integer.

Example Request ​

bash
curl -X GET "https://api.xvid.com/v1/playlists/hls.m3u8?autograph_tag=XVID_TEST&file_id=54820cec18bac397e161aebc" \
  -H "Authorization: Bearer AUTH_TOKEN"

Example Response ​

HLS Playlist ​

plaintext
#EXTM3U
#EXT-X-MEDIA:NAME="Xvid MediaHub Video",LANGUAGE="en",AUTOSELECT="yes",DEFAULT="yes",URI="https://autograph.xvid.com:443/api/v1/segments/job_id/5daedac4e4b03303cd50b851/base/547f3eede4b025bcbff38655%3Barchive%3B/tag/XVID_TEST/crypt_tag/O_NyeiFPPpPVZXmqcwEPLZ7vGTrFPMiAwcqMgttOEOlQ/client_id/57fc1561e4b09eea4328115e/user_id/547f3eede4b025bcbff38655/expiry_time/1683296550/sign/2d62b553801640170db28faad5cde5910589ac7d/map/true/url/5dafdac4e4b03703cd50b851/output_0/QIHoEmOnoxv5-0GovkRp66e5qK4fl7dchX_audio.m3u8",CODECS="mp4a.40.2",TYPE="AUDIO",GROUP-ID="audio"
#EXT-X-STREAM-INF:BANDWIDTH=8800000,AUDIO="audio",RESOLUTION=1920x1080,CODECS="avc1.640028,mp4a.40.2"
https://autograph.xvid.com:443/api/v1/segments/job_id/5daedac4e4b03303cd50b851/base/547f3eede4b025bcbff38655%3Barchive%3B/tag/XVID_TEST/crypt_tag/O_NyeiFPPpPVZXmqcwEPLZ7vGTrFPMiAwcqMgttOEOlQ/client_id/57fc1561e4b09eea4328115e/user_id/547f3eede4b025bcbff38655/expiry_time/1683296550/sign/2d62b553801640170db28faad5cde5910589ac7d/map/true/url/5daedac4e4b03703cd50b851/output_0/QIHoEmOnoxv5-0GovkRp66e5qK4fl7dchX_video.m3u8