Get a created channel's plan

GET/streams/{id}/plan/

read Read: looks, changes nothing. Scopes

What a created channel plays, in which order, at which fixed times and how it looks. It is written with the stream (plan in a create or an update). 404 for other streams.

Path parameters

idstring (uuid)required
The stream's id.

Response

200 OK

orderstring
- in_order - In order
- shuffle - Shuffled
One of: "in_order" "shuffle"
endingstring
- loop - Start again from the top
- once - Play once, then turn the channel off
One of: "loop" "once"
formatstring
- auto - Convert only the titles in another format
- copy - Never convert (cheapest)
- convert - Convert every title (needed for the logo and the banner)
One of: "auto" "copy" "convert"
logoboolean
Draw the channel logo on the picture. Every title is then converted.
logo_cornerstring
- top-right - Top right
- top-left - Top left
- bottom-right - Bottom right
- bottom-left - Bottom left
One of: "top-right" "top-left" "bottom-right" "bottom-left"
banner_minutesinteger
Show "Next: " during the last this many minutes of each title (0 = never). Every title is then converted. </div></li><li class="field"><div class="field-head"><code class="field-name">timezone</code>string</div><div class="field-text">The time zone the fixed times are written in. </div></li><li class="field"><div class="field-head"><code class="field-name">guide</code>string</div><div class="field-text"><ul> <li><code>made</code> - Made from the schedule</li> <li><code>edited</code> - Made from the schedule, with my changes</li> <li><code>own</code> - A guide I choose</li> </ul> </div>One of: <code>"made"</code> <code>"edited"</code> <code>"own"</code></li><li class="field"><div class="field-head"><code class="field-name">items</code>object[]</div><ul class="fields nested"><li class="field"><div class="field-head"><code class="field-name">kind</code>stringrequired</div><div class="field-text"><ul> <li><code>movie</code> - A film</li> <li><code>episode</code> - An episode</li> <li><code>series</code> - A whole show</li> <li><code>season</code> - A season</li> <li><code>movie_category</code> - The films of a category</li> <li><code>series_category</code> - The shows of a category</li> <li><code>all_movies</code> - Every film</li> <li><code>all_episodes</code> - Every episode</li> <li><code>everything</code> - Every film and episode</li> </ul> </div>One of: <code>"movie"</code> <code>"episode"</code> <code>"series"</code> <code>"season"</code> <code>"movie_category"</code> <code>"series_category"</code> <code>"all_movies"</code> <code>"all_episodes"</code> <code>"everything"</code></li><li class="field"><div class="field-head"><code class="field-name">movie</code>string (uuid)can be null</div></li><li class="field"><div class="field-head"><code class="field-name">episode</code>string (uuid)can be null</div></li><li class="field"><div class="field-head"><code class="field-name">series</code>string (uuid)can be null</div></li><li class="field"><div class="field-head"><code class="field-name">season</code>string (uuid)can be null</div></li><li class="field"><div class="field-head"><code class="field-name">category</code>string (uuid)can be null</div></li><li class="field"><div class="field-head"><code class="field-name">label</code>stringrequiredread-only</div></li></ul></li><li class="field"><div class="field-head"><code class="field-name">slots</code>object[]</div><ul class="fields nested"><li class="field"><div class="field-head"><code class="field-name">kind</code>stringrequired</div><div class="field-text"><ul> <li><code>movie</code> - A film</li> <li><code>episode</code> - An episode</li> <li><code>series</code> - A whole show</li> <li><code>season</code> - A season</li> <li><code>movie_category</code> - The films of a category</li> <li><code>series_category</code> - The shows of a category</li> <li><code>all_movies</code> - Every film</li> <li><code>all_episodes</code> - Every episode</li> <li><code>everything</code> - Every film and episode</li> </ul> </div>One of: <code>"movie"</code> <code>"episode"</code> <code>"series"</code> <code>"season"</code> <code>"movie_category"</code> <code>"series_category"</code> <code>"all_movies"</code> <code>"all_episodes"</code> <code>"everything"</code></li><li class="field"><div class="field-head"><code class="field-name">movie</code>string (uuid)can be null</div></li><li class="field"><div class="field-head"><code class="field-name">episode</code>string (uuid)can be null</div></li><li class="field"><div class="field-head"><code class="field-name">series</code>string (uuid)can be null</div></li><li class="field"><div class="field-head"><code class="field-name">season</code>string (uuid)can be null</div></li><li class="field"><div class="field-head"><code class="field-name">category</code>string (uuid)can be null</div></li><li class="field"><div class="field-head"><code class="field-name">label</code>stringrequiredread-only</div></li><li class="field"><div class="field-head"><code class="field-name">starts</code>string (time)required</div></li><li class="field"><div class="field-head"><code class="field-name">date</code>string (date)can be null</div></li><li class="field"><div class="field-head"><code class="field-name">length_minutes</code>integercan be null</div></li><li class="field"><div class="field-head"><code class="field-name">count</code>integer</div>Default: <code>1</code></li></ul></li><li class="field"><div class="field-head"><code class="field-name">started_at</code>string (date-time)requiredread-only</div></li><li class="field"><div class="field-head"><code class="field-name">ends_at</code>string (date-time)requiredread-onlycan be null</div></li><li class="field"><div class="field-head"><code class="field-name">waiting</code>anyrequiredread-only</div></li><li class="field"><div class="field-head"><code class="field-name">updated_at</code>string (date-time)requiredread-only</div></li></ul><h2 id="errors">Errors<a class="anchor" href="#errors" aria-hidden="true" tabindex="-1">#</a></h2><ul class="errors"><li>401 No credential, or one that is wrong, expired or revoked.</li><li>403 The account, or the key's or app's scopes, may not do this.</li><li>404 </li><li>429 Slow down: wait the seconds in the Retry-After header, then try again.</li></ul><a href="/api/errors/">What each error means</a></div><aside class="op-aside" aria-label="Example"><div class="code-group" data-tabs><figure class="code" data-tab-title="cURL"><figcaption>cURL</figcaption><pre><code class="language-bash">curl 'https://panel.example.com/streams/1/plan/' \ -H "Authorization: Bearer $MINIMUS_API_KEY"</code></pre><button class="copy" type="button" data-copy aria-label="Copy">Copy</button></figure><figure class="code" data-tab-title="Python"><figcaption>Python</figcaption><pre><code class="language-python">import os import requests response = requests.get( "https://panel.example.com/streams/1/plan/", headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"}, ) response.raise_for_status() print(response.json())</code></pre><button class="copy" type="button" data-copy aria-label="Copy">Copy</button></figure><figure class="code" data-tab-title="JavaScript"><figcaption>JavaScript</figcaption><pre><code class="language-javascript">const response = await fetch('https://panel.example.com/streams/1/plan/', { method: 'GET', headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}` }, }); if (!response.ok) throw new Error(`${response.status}`); console.log(await response.json());</code></pre><button class="copy" type="button" data-copy aria-label="Copy">Copy</button></figure></div><figure class="code" data-tab-title="Response 200"><figcaption>Response 200</figcaption><pre><code class="language-json">{ "order": "in_order", "ending": "loop", "format": "auto", "logo": true, "logo_corner": "top-right", "banner_minutes": 1, "timezone": "string", "guide": "made", "items": [ { "kind": "movie", "movie": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b", "episode": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b", "series": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b", "season": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b", "category": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b", "label": "string" } ], "slots": [ { "kind": "movie", "movie": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b", "episode": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b", "series": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b", "season": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b", "category": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b", "label": "string", "starts": "string", "date": "2026-11-13", "length_minutes": 1, "count": 1 } ], "started_at": "2026-11-13T12:00:00Z", "ends_at": "2026-11-13T12:00:00Z", "waiting": "string", "updated_at": "2026-11-13T12:00:00Z" }</code></pre><button class="copy" type="button" data-copy aria-label="Copy">Copy</button></figure></aside></div></article> <footer class="docs-footer"> Something unclear or missing? <a href="mailto:support@minimus.tv">support@minimus.tv</a> · <a href="https://discord.gg/pKBES3bSfw">Discord</a> © MOOSY LLC · <a href="https://minimus.tv/">minimus.tv</a> · <a href="https://minimus.tv/terms.html">Licence terms</a> · <a href="https://minimus.tv/privacy.html">Privacy</a> </footer> </main> <nav class="toc" aria-label="On this page">On this page<ul><li class="l2"><a href="#path-parameters">Path parameters</a></li><li class="l2"><a href="#response">Response</a></li><li class="l2"><a href="#errors">Errors</a></li></ul></nav> </div> </body> </html>

Get a created channel's plan

Path parameters#

Response#

200 OK

Path parameters

Response