minimusdocs
Help center

Playlist editor API

Get a background task

GET/editor/api/v1/jobs/{id}/

Called with a playlist editor API token. How

Its progress and log, and once it has ended, its result. Only tasks of the token's playlists.

Path parameters

  • idstring (uuid)required

Headers

  • X-Token-Passwordstring

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

Response

200 OK

  • idstring (uuid)required
  • typestringrequired
    • import - Playlist import
    • add - Content added from another source
    • sync - Playlist sync
    • provider - Provider change
    • restore - Backup restore
    • duplicate - Playlist copy
    • guide - Guide matching
    • logos - Logo matching
    • info - Film and show info
    • migrate - Move to a new provider
    • episodes - Episodes of every show

    One of: "import" "add" "sync" "provider" "restore" "duplicate" "guide" "logos" "info" "migrate" "episodes"

  • statusstringrequired
    • queued - Queued
    • running - Running
    • completed - Completed
    • failed - Failed
    • cancelled - Cancelled

    One of: "queued" "running" "completed" "failed" "cancelled"

  • titlestringrequired
  • playliststring (uuid)requiredcan be null
  • ownerstringrequiredcan be null

    The account's username.

  • progressintegerrequired

    0 to 100.

  • stepstringrequired

    What it is doing now.

  • errorstringrequired
  • doneintegerrequiredcan be null
  • totalintegerrequiredcan be null
  • created_atstring (date-time)required
  • started_atstring (date-time)requiredcan be null
  • updated_atstring (date-time)required
  • finished_atstring (date-time)requiredcan be null
  • resultobject

    What it found or did, by type of task. Not in lists.

  • logstring

    Not in lists.

Errors

  • 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.
  • 404 Nothing with this id, or nothing the account can see.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means