List a created channel's guide titles

GET/streams/{id}/guide/

read Read: looks, changes nothing. Scopes

The titles a created channel plays, in order, each with what its guide says by itself (made) and your own words for it (edit, or null). 404 for other streams.

Path parameters

idstring (uuid)required
The stream's id.

Query parameters

pageinteger
From 1.
page_sizeinteger
1 to 200; 50 by default.

Response

200 OK

countintegerrequired
resultsobject[]required
- keystringrequired
- kindstringrequired
  - movie - movie
  - episode - episode
  One of: "movie" "episode"
- namestringrequired
- madeobjectrequired
  - titlestringrequired
  - sub_titlestringrequired
  - descriptionstringrequired
- editobjectrequiredcan be null
  - titlestringrequired
  - sub_titlestringrequired
  - descriptionstringrequired

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
429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means

cURL

curl 'https://panel.example.com/streams/1/guide/' \
  -H "Authorization: Bearer $MINIMUS_API_KEY"

Python

import os
import requests

response = requests.get(
    "https://panel.example.com/streams/1/guide/",
    headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"},
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/streams/1/guide/', {
  method: 'GET',
  headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}` },
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 200

{
  "count": 0,
  "results": [
    {
      "key": "string",
      "kind": "movie",
      "name": "Channel A",
      "made": {
        "title": "Channel A",
        "sub_title": "Channel A",
        "description": "string"
      },
      "edit": {
        "title": "Channel A",
        "sub_title": "Channel A",
        "description": "string"
      }
    }
  ]
}

List a created channel's guide titles

Path parameters#

Query parameters#

Response#

200 OK

Errors#

Path parameters

Query parameters

Response

Errors