Read the categories of a source

POST/editor/sources/scan/

write Change: creates or edits. Scopes

Reads the categories of a source in a background task, to pick the ones to import. The finished task lists them by kind in its result.

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[]
Default: all.

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

Response

202 OK

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

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

cURL

curl -X POST 'https://panel.example.com/editor/sources/scan/' \
  -H "Authorization: Bearer $MINIMUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "source": {
    "type": {
      "0": "x",
      "1": "t",
      "2": "r",
      "3": "e",
      "4": "a",
      "5": "m"
    },
    "url": "https://example.com/",
    "username": "alice"
  }
}'

Python

import os
import requests

response = requests.post(
    "https://panel.example.com/editor/sources/scan/",
    headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"},
    json={
        "source": {
            "type": {
                "0": "x",
                "1": "t",
                "2": "r",
                "3": "e",
                "4": "a",
                "5": "m"
            },
            "url": "https://example.com/",
            "username": "alice"
        }
    },
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/editor/sources/scan/', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "source": {
      "type": {
        "0": "x",
        "1": "t",
        "2": "r",
        "3": "e",
        "4": "a",
        "5": "m"
      },
      "url": "https://example.com/",
      "username": "alice"
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 202

{
  "job": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b"
}

Read the categories of a source

Body#

Response#

202 OK

Errors#

Body

Response

Errors