Contents
On this page

Get Episode - Plugixa Stream

GET /plugixa-stream/v1/admin/episodes/{id}

One episode as the editor sees it, whatever its status.

Needs a user with the plugixa_stream_view capability (signed in with an Application Password or the login cookie). Administrators hold it; other roles only when you grant it.

Request

GET https://your-site.example/wp-json/plugixa-stream/v1/admin/episodes/2815

Path parameters

Name Type Description
id integer The episode’s id

Responses

200 OK. data is the episode.

{
  "success": true,
  "data": {
    "id": 2815,
    "series_id": 2814,
    "number": 1,
    "title": "Chapter 1: The Planet of Peril",
    "description": "",
    "status": "publish",
    "publish_at": "",
    "url": "https://your-site.example/episode/flash-gordon-ep-1/",
    "season": 1,
    "provider": "self_hosted",
    "asset_id": "https://archive.org/download/flash-gordon-1936/chapter-1.mp4",
    "duration": 1134,
    "thumbnail_id": 0,
    "access": "auto",
    "price_override": null,
    "intro_start": null,
    "intro_end": null,
    "credits_start": null,
    "thumbnail_url": "",
    "subtitles": [],
    "audio_tracks": []
  }
}
Field Type Meaning
data.id integer The episode’s id
data.series_id integer Its title
data.number integer Episode number, unique within the title
data.title string Raw title
data.description string HTML as stored
data.status string publish, draft or future (scheduled)
data.publish_at string A scheduled episode’s release, site time, Y-m-d H:i:s; empty otherwise
data.url string Public page
data.season integer Season, 0 when not set
data.provider string self_hosted, embed, with Pro bunny; empty means the site’s video service
data.asset_id string A Media Library id or video URL (self-hosted), an https embed link (embed), or a video GUID (Bunny)
data.duration integer Seconds
data.thumbnail_id integer Media Library id, 0 for none
data.access string auto, free or paid
data.price_override integer|null Coins for this episode PRO, null for the usual price
data.intro_start integer|null Seconds. Also intro_end and credits_start
data.thumbnail_url string Thumbnail, medium size
data.subtitles object[] Pro: subtitle tracks (lang, label, attachment_id, source, from, kind, url)
data.audio_tracks object[] Pro: dubbed audio tracks, same fields

Errors

Status Code When
401 / 403 plugixa_stream_forbidden The caller lacks the capability.
404 plugixa_stream_not_found No episode with that id.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-stream/v1/admin/episodes/2815" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/episodes/2815');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/admin/episodes/2815', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share