mirror of
https://gitlab.com/vyla-entertainment/documentation.git
synced 2026-11-16 23:47:22 -05:00
huge doc rewrite
This commit is contained in:
282
ai-catalog.json
282
ai-catalog.json
@@ -1,177 +1,113 @@
|
||||
{
|
||||
"name": "Vyla Documentation",
|
||||
"description": "Comprehensive documentation for Vyla - a community-built, self-hosted media project focused on freedom, privacy, and user control. Includes SDK reference, Stream API documentation, and guides for building custom media players.",
|
||||
"url": "https://vyla.cc",
|
||||
"type": "documentation",
|
||||
"category": "software",
|
||||
"tags": [
|
||||
"media streaming",
|
||||
"self-hosted",
|
||||
"privacy",
|
||||
"open source",
|
||||
"SDK",
|
||||
"API",
|
||||
"Node.js",
|
||||
"TypeScript",
|
||||
"Android",
|
||||
"Android TV",
|
||||
"desktop",
|
||||
"streaming",
|
||||
"video player",
|
||||
"HLS",
|
||||
"SSE"
|
||||
],
|
||||
"language": "en",
|
||||
"version": "1.0.0",
|
||||
"lastUpdated": "2026-10-06",
|
||||
"maintainer": {
|
||||
"name": "Vyla Entertainment",
|
||||
"url": "https://gitlab.com/vyla-entertainment/"
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"name": "Vyla Entertainment",
|
||||
"identifier": "vyla-entertainment",
|
||||
"description": "A community-built media streaming and scraper ecosystem providing native applications, a Node.js resolver SDK, and a self-hosted Stream API.",
|
||||
"homepage": "https://vyla.cc",
|
||||
"documentation": "https://vyla.cc",
|
||||
"llms_context": "https://vyla.cc/llms.txt",
|
||||
"repository": "https://gitlab.com/vyla-entertainment",
|
||||
"community": "https://discord.gg/5eqRhKeywG",
|
||||
"license": "Open Source",
|
||||
"ecosystem": {
|
||||
"clients": [
|
||||
{
|
||||
"name": "Vyla Home",
|
||||
"platform": [
|
||||
"Windows",
|
||||
"macOS",
|
||||
"Linux"
|
||||
],
|
||||
"description": "Desktop control center and self-contained runtime.",
|
||||
"documentation": "https://vyla.cc/products/home"
|
||||
},
|
||||
{
|
||||
"name": "Vyla Go",
|
||||
"platform": [
|
||||
"Android"
|
||||
],
|
||||
"description": "Mobile application running local resolver services.",
|
||||
"documentation": "https://vyla.cc/products/go"
|
||||
},
|
||||
{
|
||||
"name": "Vyla TV",
|
||||
"platform": [
|
||||
"Android TV"
|
||||
],
|
||||
"description": "Television interface built with Jetpack Compose and ExoPlayer.",
|
||||
"documentation": "https://vyla.cc/products/tv"
|
||||
}
|
||||
],
|
||||
"libraries": [
|
||||
{
|
||||
"package": "@vyla-entertainment/sdk",
|
||||
"language": "Node.js (>=18)",
|
||||
"description": "Server-side resolver library for stream links, subtitle extraction, and download links.",
|
||||
"documentation": "https://vyla.cc/sdk"
|
||||
}
|
||||
],
|
||||
"services": [
|
||||
{
|
||||
"name": "Stream API",
|
||||
"type": "Self-hosted HTTP/SSE Proxy",
|
||||
"description": "REST and Server-Sent Events service wrapping Vyla SDK for remote clients.",
|
||||
"default_port": 7860,
|
||||
"protocols": [
|
||||
"HTTP",
|
||||
"SSE"
|
||||
],
|
||||
"documentation": "https://vyla.cc/stream-api/overview",
|
||||
"endpoints": [
|
||||
{
|
||||
"path": "/movie",
|
||||
"method": "GET",
|
||||
"query_parameters": [
|
||||
"id"
|
||||
],
|
||||
"response_type": "text/event-stream"
|
||||
},
|
||||
{
|
||||
"path": "/tv",
|
||||
"method": "GET",
|
||||
"query_parameters": [
|
||||
"id",
|
||||
"season",
|
||||
"episode"
|
||||
],
|
||||
"response_type": "text/event-stream"
|
||||
},
|
||||
{
|
||||
"path": "/subtitles/movie/:id",
|
||||
"method": "GET",
|
||||
"response_type": "application/json"
|
||||
},
|
||||
{
|
||||
"path": "/subtitles/tv/:id/:season/:episode",
|
||||
"method": "GET",
|
||||
"response_type": "application/json"
|
||||
},
|
||||
{
|
||||
"path": "/downloads/movie/:id",
|
||||
"method": "GET",
|
||||
"response_type": "application/json"
|
||||
},
|
||||
{
|
||||
"path": "/downloads/tv/:id/:season/:episode",
|
||||
"method": "GET",
|
||||
"response_type": "application/json"
|
||||
},
|
||||
{
|
||||
"path": "/health",
|
||||
"method": "GET",
|
||||
"response_type": "application/json"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"documentation": {
|
||||
"main": "https://vyla.cc",
|
||||
"llms": "https://vyla.cc/llms.txt",
|
||||
"repository": "https://gitlab.com/vyla-entertainment/"
|
||||
},
|
||||
"topics": [
|
||||
{
|
||||
"name": "Getting Started",
|
||||
"pages": [
|
||||
{
|
||||
"title": "Introduction",
|
||||
"url": "/"
|
||||
},
|
||||
{
|
||||
"title": "Architecture",
|
||||
"url": "/architecture"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Products",
|
||||
"pages": [
|
||||
{
|
||||
"title": "Vyla Home",
|
||||
"url": "/home"
|
||||
},
|
||||
{
|
||||
"title": "Vyla Go",
|
||||
"url": "/go"
|
||||
},
|
||||
{
|
||||
"title": "Vyla TV",
|
||||
"url": "/tv"
|
||||
},
|
||||
{
|
||||
"title": "Build a Player",
|
||||
"url": "/player"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "SDK",
|
||||
"pages": [
|
||||
{
|
||||
"title": "SDK Reference",
|
||||
"url": "/sdk"
|
||||
},
|
||||
{
|
||||
"title": "SDK Quickstart",
|
||||
"url": "/sdk-quickstart"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Stream API",
|
||||
"pages": [
|
||||
{
|
||||
"title": "Overview",
|
||||
"url": "/stream-api/overview"
|
||||
},
|
||||
{
|
||||
"title": "Paths and Events",
|
||||
"url": "/stream-api/paths"
|
||||
},
|
||||
{
|
||||
"title": "Subtitles and Downloads",
|
||||
"url": "/stream-api/media-data"
|
||||
},
|
||||
{
|
||||
"title": "Health and Operations",
|
||||
"url": "/stream-api/operations"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Deployment",
|
||||
"pages": [
|
||||
{
|
||||
"title": "Self-hosting",
|
||||
"url": "/self-hosting"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Concepts",
|
||||
"pages": [
|
||||
{
|
||||
"title": "Providers",
|
||||
"url": "/concepts/providers"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Guides",
|
||||
"pages": [
|
||||
{
|
||||
"title": "Client Integration",
|
||||
"url": "/guides/integrations"
|
||||
},
|
||||
{
|
||||
"title": "Error Handling",
|
||||
"url": "/guides/error-handling"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Miscellaneous",
|
||||
"pages": [
|
||||
{
|
||||
"title": "Credits",
|
||||
"url": "/misc/credit"
|
||||
},
|
||||
{
|
||||
"title": "DMCA Policy",
|
||||
"url": "/misc/dmca"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"apis": [
|
||||
{
|
||||
"name": "Vyla SDK",
|
||||
"type": "npm",
|
||||
"package": "@vyla-entertainment/sdk",
|
||||
"description": "Node.js/TypeScript SDK for direct provider resolution",
|
||||
"language": "TypeScript"
|
||||
},
|
||||
{
|
||||
"name": "Stream API",
|
||||
"type": "http",
|
||||
"description": "Self-hosted HTTP/SSE API for browser and mobile clients",
|
||||
"protocol": "SSE"
|
||||
}
|
||||
],
|
||||
"platforms": [
|
||||
"Windows",
|
||||
"macOS",
|
||||
"Linux",
|
||||
"Android",
|
||||
"Android TV"
|
||||
],
|
||||
"license": "ISC",
|
||||
"community": {
|
||||
"discord": "https://discord.gg/5eqRhKeywG",
|
||||
"gitlab": "https://gitlab.com/vyla-entertainment/"
|
||||
"compliance": {
|
||||
"hosting_policy": "Non-hosting scraper proxy; all video segments originate from third-party hosts.",
|
||||
"dmca_contact": "alwaysmesmerizingyou@gmail.com",
|
||||
"dmca_policy": "https://vyla.cc/misc/project/dmca"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user