SDK Reference

Scrape video streams, fetch subtitles, retrieve download links, and monitor provider health directly from your Node.js application.

The Vyla SDK (@vyla-entertainment/sdk) is a server-side JavaScript/TypeScript package that provides direct access to Vyla's stream resolvers, health probes, download resolvers, and subtitle providers.

By embedding the SDK directly into your backend application, provider resolution executes in your own environment. It is an alternative to operating the Stream API as a separate process: your application owns its request boundary, caching, authorization, timeouts, and response shape.

Features

• Direct-to-Client Playback: Scraped streams link directly to source CDNs. No proxy server overhead required unless specified by provider headers.
• Built-In Health Probing: Monitor latency and uptime per provider with built-in health check utilities.
• Automated Anime Sub/Dub Routing: Automatically configures audio track requirements (sub vs dub) based on provider naming conventions.
• Multi-Source Subtitle Aggregation: Merges subtitle tracks from multiple redundant subtitle mirrors into a unified VTT/SRT format.
• Metadata Fallbacks: Automatically maps TMDB IDs to external IDs (such as IMDB and AniList) for smooth stream lookups.
• Self-Contained: No need to deploy a separate API server — all streaming functionality runs within your existing Node.js application.

Installation

Install the package into your Node.js backend using your package manager of choice:

npm install @vyla-entertainment/sdk

pnpm install @vyla-entertainment/sdk

yarn add @vyla-entertainment/sdk

Note: Node.js v18+ is required due to modern standard fetch and AbortSignal.timeout usage.

Initialization

Initialize the VylaSDK client by supplying your TMDB API Key. The key resolves media metadata, validates movie/TV show IDs, and translates TMDB IDs into AniList IDs for anime sources.

You may optionally provide a pengu.uk manifest URL to enable the Pengu source.

import VylaSDK from "@vyla-entertainment/sdk";

const sdk = new VylaSDK({
  tmdbApiKey: process.env.TMDB_API_KEY,

  penguManifest: "" // Optional, get from pengu.uk
});

Core Methods

getStream(key, id, s?, e?, clientIP?)

Scrapes video stream URLs and playability headers for a specified provider key.

// Fetch a movie stream (TMDB ID: 155 - The Dark Knight)
const movieStream = await sdk.getStream("sourcename", "155");

// Fetch a TV show episode (TMDB ID: 1399, Season 1, Episode 1)
const tvStream = await sdk.getStream("sourcename", "1399", 1, 1);

// Pass client IP for providers that use geo-verification
const geoStream = await sdk.getStream("sourcename", "155", null, null, "203.0.113.195");

Parameters

Example Response Format

{
  "url": "https://example-cdn.com/hls/manifest.m3u8",
  "quality": "auto",
  "isM3U8": true,
  "headers": {
    "Referer": "https://example.com/",
    "Origin": "https://example.com"
  },
  "allUrls": [
    {
      "url": "https://example-cdn.com/hls/manifest.m3u8",
      "quality": "1080p",
      "isM3U8": true
    }
  ]
}

getSubtitles(id, s?, e?)

Fetches subtitle files aggregated across multiple subtitle backend mirrors (v1, v2, febbox). Returns clean VTT and SRT tracks.

// Fetch movie subtitles
const movieSubs = await sdk.getSubtitles("155");

// Fetch TV show episode subtitles
const tvSubs = await sdk.getSubtitles("1399", 1, 1);

Parameters

Example Response Format

[
  {
    "label": "English",
    "file": "https://sub.vdrk.site/v1/vtt/movie/155/English.vtt",
    "type": "vtt",
    "source": "v1"
  },
  {
    "label": "Spanish",
    "file": "https://fed-subs.pstream.mov/subtitles/spanish.srt",
    "type": "srt",
    "source": "febbox"
  }
]

getDownloads(id, s?, e?)

Fetches direct downloadable media files (MP4/MKV) paired with resolution and file size descriptors.

// Movie downloads
const downloads = await sdk.getDownloads("155");

// TV Episode downloads
const tvDownloads = await sdk.getDownloads("1399", 1, 1);

Example Response Format

[
  {
    "url": "https://download-node.com/file/the-dark-knight-1080p.mp4",
    "quality": "1080p",
    "size": "2.14 GB",
    "format": "MP4"
  }
]

Provider & Health Management

getSources(excludeDisabled?)

Retrieves provider configurations registered in the SDK.

// Get all sources including temporarily disabled ones
const allSources = sdk.getSources(false);

// Get only active/enabled sources
const activeSources = sdk.getSources(true);

Parameters

probeSource(key)

Executes a health ping test against a single provider to determine current availability and latency using a probe payload (TMDB ID: 155).

const health = await sdk.probeSource("vidrock");
console.log(health);
// Output: { ok: true, ms: 840 }

probeAllSources()

Executes health tests in parallel across all non-disabled provider modules.

const results = await sdk.probeAllSources();
console.log(results);

Example Response Format

{
  "sourcename1": { "ok": true, "ms": 420 },
  "sourcename2": { "ok": true, "ms": 1150 },
  "sourcename3": { "ok": false, "ms": null }
}

Provider Metadata Properties

When calling getSources(), each provider entry returns metadata describing its features and streaming behavior:

{
  key: 'example',
  label: 'Example',
  sourceFile: 'example',
  proxyParam: 'ex',
  timeout: 20000,
  jitter: 800,
  retries: 3,
  multiUrl: true,
  skipProxy: false,
  cdnHeaders: [{
    pattern: /./,
    headers: {
      Referer: 'https://example.com/',
      Origin: 'https://example.com'
    }
  }]
}

Property Reference

Practical Express.js Backend Example

Here is an example showing how to serve stream links to your client web application while handling custom CDN playback headers and subtitle merging:

import express from "express";
import VylaSDK from "@vyla-entertainment/sdk";

const app = express();
const sdk = new VylaSDK({ tmdbApiKey: process.env.TMDB_API_KEY });

// Scrape stream route
app.get("/api/stream", async (req, res) => {
  const { provider, tmdbId, season, episode } = req.query;
  const clientIP = req.headers["x-forwarded-for"] || req.socket.remoteAddress;

  try {
    const streamData = await sdk.getStream(
      provider,
      tmdbId,
      season || null,
      episode || null,
      clientIP
    );

    if (!streamData || !streamData.url) {
      return res.status(404).json({ error: "No stream found for this provider" });
    }

    return res.json({
      success: true,
      provider,
      stream: streamData,
    });
  } catch (error) {
    return res.status(500).json({ error: error.message });
  }
});

// Fetch subtitles route
app.get("/api/subtitles", async (req, res) => {
  const { tmdbId, season, episode } = req.query;

  try {
    const subtitles = await sdk.getSubtitles(
      tmdbId,
      season || null,
      episode || null
    );

    return res.json({ subtitles });
  } catch (error) {
    return res.status(500).json({ subtitles: [] });
  }
});

app.listen(3000, () => console.log("Vyla SDK Server running on port 3000"));

SDK vs Self-Hosted API

The SDK and the self-hosted API server provide the same streaming functionality but in different deployment models:

Choose the SDK if you want to integrate streaming directly into an existing Node.js application. Choose the self-hosted API if you want a standalone streaming service that can be used by multiple clients.