minimusdocs
Help center

Playlist editor API

Import a new playlist

POST/editor/api/v1/playlists/import/

Called with a playlist editor API token. How

Makes a new playlist and fills it from a source in a background task: a provider login ("type": "xtream"), an M3U address or an uploaded M3U file. Answers the new playlist and its task. kinds: channels (live, the default), movie and series. attributes: what to take from the source besides names and links (default: category and logo). categories: per kind, the ids of the source's categories to take (from a read of its categories); the others come in already in the bin. A token limited to some playlists cannot make one.

Headers

  • X-Token-Passwordstring

    The token's own password, when it was made with one.

Body

  • sourceobjectrequired
    • typestring

      Where the list comes from. Leave it out to name a provider instead.

      • xtream - A provider login: url (the server), username and password
      • m3u - An M3U address: url
      • file - An M3U file sent with POST /editor/uploads/: upload
    • urlstring

      The server (xtream) or the M3U address (m3u).

    • usernamestring
    • passwordstring
    • formatstring

      How channel links are written (xtream): ts (the default), live_ts or live_hls.

    • uploadstring

      The id POST /editor/uploads/ answered (file).

    • providerinteger

      One of the playlist's providers, by id, instead of the above.

  • kindsstring[]

    One of: "live" "movie" "series"

    Default: ["live"]

  • attributesstring[]

    One of: "category" "logo" "epg_id" "epg_shift" "number"

    Default: ["category","logo"]

  • categoriesobject
  • namestringrequired

Response

202 OK

  • jobstring (uuid)required

    The background task: follow it with GET /editor/jobs/{id}/ (/editor/api/v1/jobs/{id}/ with a token).

  • playliststring (uuid)required

    The playlist the task fills.

Errors

  • 400 Something sent is not valid. Each field that is wrong is named with what is wrong.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means