Contents
On this page

Play Episode - Plugixa Stream

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

The only route that hands out a stream URL. It decides on the server, for this caller, whether the episode may play. A locked episode answers 200 with locked: true and no URL.

Public: free episodes play for guests. Signed in, the caller’s unlocks and VIP PRO count, and position is their resume point. Rate-limited: 60 requests a minute per signed-in user, or per IP address for guests.

Request

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

Path parameters

Name Type Description
id integer The episode’s id

Responses

200 OK, may play. source is the stream.

{
  "success": true,
  "data": {
    "episode": {
      "id": 2815,
      "series_id": 2814,
      "number": 1,
      "season": 1,
      "title": "Chapter 1: The Planet of Peril",
      "duration": 1134,
      "thumbnail": "",
      "free": true,
      "locked": false
    },
    "next": {
      "id": 2816,
      "series_id": 2814,
      "number": 2,
      "season": 1,
      "title": "Chapter 2: The Tunnel of Terror",
      "duration": 1147,
      "thumbnail": "",
      "free": true,
      "locked": false
    },
    "locked": false,
    "source": {
      "type": "mp4",
      "url": "https://your-site.example/wp-content/uploads/2026/10/flash-gordon-chapter-1.mp4",
      "expires": 0
    },
    "markers": {
      "intro_start": 0,
      "intro_end": 42,
      "credits_start": 1100
    },
    "position": 0
  }
}
Field Type Meaning
data.episode object The episode, in the shape Get Title lists them
data.next object|null The next published episode and its lock state, so the player can preload it, or null after the last
data.locked boolean false
data.source.type string mp4, hls or embed
data.source.url string What the player loads
data.source.expires integer Unix time a signed URL stops working, 0 when it does not expire
data.source.embed string Embed episodes only: youtube, vimeo, iframe or video
data.markers object Skip points in seconds: intro_start and intro_end together, credits_start. Only consistent ones are sent; {} when none
data.position integer Where to resume, in seconds. 0 for guests, and when the episode was finished
data.watermark string Only when Show the viewer’s email over the video is on and the caller is signed in: their email and account id, drawn over the video

With Pro the answer can also hold subtitles and audio_tracks (each lang, label, url, ai, kind), original_lang, and ads when this viewer sees ads. On Bunny Stream, source is a signed hls URL with a real expires; once an encode has finished, an uploaded MP4 plays as hls.

200 OK, locked. No source.

{
  "success": true,
  "data": {
    "episode": {
      "id": 2818,
      "series_id": 2814,
      "number": 4,
      "season": 1,
      "title": "Chapter 4: Battling the Sea Beast",
      "duration": 1034,
      "thumbnail": "",
      "free": false,
      "locked": true
    },
    "next": {
      "id": 2819,
      "series_id": 2814,
      "number": 5,
      "season": 1,
      "title": "Chapter 5: The Destroying Ray",
      "duration": 1012,
      "thumbnail": "",
      "free": false,
      "locked": true
    },
    "locked": true,
    "offer": {
      "login_required": true,
      "price": 50,
      "balance": 0,
      "bundle": {
        "locked": 10,
        "full_price": 500,
        "bundle_price": 350,
        "discount": 30
      },
      "vip": true
    }
  }
}
Field Type Meaning
data.offer object What the caller is offered. {} in the free plugin, which sells nothing
data.offer.login_required boolean Pro: the caller is a guest
data.offer.price integer Pro: coins to unlock this episode
data.offer.balance integer Pro: the caller’s coins
data.offer.bundle object|null Pro: the whole-series price when more than one episode is locked
data.offer.vip boolean Pro: VIP plans exist

With Pro, a screen limit can also hold back an episode the caller may otherwise play: then offer.kind is screens, with the limit and the other screens.

Errors

Status Code When
404 plugixa_stream_not_found No such episode, it or its title is not published, or a kids profile PRO may not see the title.
404 plugixa_stream_no_video The episode has no video yet.
429 plugixa_stream_rate_limited More than 60 requests in the current minute.
503 plugixa_stream_provider_missing The episode is stored on a video service that is not installed, for example Bunny Stream after Pro was removed.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-stream/v1/episodes/2815/play"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/episodes/2815/play');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/episodes/2815/play');
const { data } = await response.json();

Quick Links

Share