YTAI: Python YouTube SDK, CLI, and MCP server without user-supplied API keys
Project description
YTAI: Python YouTube SDK, CLI & MCP Server
Search, metadata, transcripts, comments, channels, and downloads — no API key required.
curl_cffi for TLS impersonation · FastMCP for agent tools · FastAPI for HTTP API · Rich for CLI
YTAI is an independent project. It is not affiliated with or endorsed by YouTube or Google. Use it in accordance with applicable terms, copyright law, and local regulations.
Contents
- Features
- Installation
- Quick start
- Downloads
- MCP server
- FastAPI server
- Documentation
- Testing
- Limitations
- Credits
Features
- Search videos, channels, and playlists with filters and pagination
- Retrieve metadata, likes, captions, related videos, and comments
- Fetch timestamped transcripts with language selection and XML fallback
- Inspect channels, recent uploads, and popular videos
- Download full video with audio, video-only, audio-only, or a time range
- Resume interrupted downloads with ranged transfers and per-chunk retries
- Cache responses in SQLite with operation-specific TTLs
- Use the Python SDK, Rich-powered
ytaiCLI, nine read-only MCP tools, or the FastAPI service
Installation
Requirements:
- Python 3.10 or newer
- No separate FFmpeg installation is required for downloads; YTAI bundles FFmpeg through
imageio-ffmpeg
Install from PyPI:
pip install youtube-ai
Or clone and install from source:
git clone https://github.com/vibheksoni/youtube-ai.git
cd youtube-ai
pip install -e .
Install development dependencies when running tests:
pip install -e ".[dev]"
FFmpeg is bundled automatically for Windows, macOS, and Linux when you install YTAI.
If you prefer a system build, it is used when ffmpeg is on PATH. To pin an
explicit binary, set YTAI_FFMPEG_PATH to its full path:
$env:YTAI_FFMPEG_PATH = "C:\tools\ffmpeg\bin\ffmpeg.exe"
YTAI_API_KEY is an optional offline fallback when live configuration cannot be
fetched. It is read from the environment and is never stored in the repository.
For environment setup and first-run guidance, continue with Getting Started.
Quick start
Use YouTubeClient as a context manager so its HTTP session is closed cleanly:
from youtube_ai import YouTubeClient
with YouTubeClient() as client:
results = client.search("python tutorial", limit=5, filter_type="video")
for item in results["results"]:
print(item["title"], item["url"])
video = client.get_video("dQw4w9WgXcQ")
print(video["details"]["title"])
print(video["details"]["likes"])
transcript = client.get_transcript("dQw4w9WgXcQ", language_codes=("en",))
for segment in transcript["snippets"][:5]:
print(f"{segment['start']:.1f}s: {segment['text']}")
Common CLI commands:
ytai search "python tutorial" --limit 10 --filter video
ytai video dQw4w9WgXcQ
ytai transcript dQw4w9WgXcQ --lang en
ytai comments dQw4w9WgXcQ --limit 20
See the Python API reference and CLI reference for complete signatures and commands.
Downloads
Inspect available qualities, codecs, stream sizes, and modes before downloading:
ytai download-options dQw4w9WgXcQ
Download a full video with audio:
ytai download dQw4w9WgXcQ --quality 720p --output ./downloads
Video-only, audio-only, and clipping are opt-in:
ytai download dQw4w9WgXcQ --quality 1080p --video-only
ytai download dQw4w9WgXcQ --audio-only
ytai download dQw4w9WgXcQ --quality 360p --start 30 --end 90
The SDK also exposes VideoQuality, DownloadMode, get_download_options(),
and download_video(). See the download API
and download example.
MCP server
Start the FastMCP server:
python mcp/server.py
It exposes nine read-only tools for search, video data, transcripts, streaming formats, comments, channels, and popular videos. Media downloading is intentionally available through the SDK and CLI only.
See MCP Server Setup for client configuration and tool parameters.
FastAPI server
Start the versioned HTTP API:
ytai-api
Swagger UI is available at http://127.0.0.1:8000/docs. The API covers search,
video data, transcripts, comments, formats, download options, channels, and
popular videos. See the FastAPI Server Guide for routes,
curl examples, configuration, validation, and deployment guidance.
Documentation
- Getting Started: prerequisites, installation, and first workflows
- API Reference: public classes, functions, enums, and return shapes
- CLI Reference: every
ytaicommand and option - MCP Server: server setup, tools, parameters, and errors
- FastAPI Server: HTTP routes, OpenAPI docs, configuration, and examples
- Examples: runnable search, metadata, transcript, comment, channel, download, and MCP scripts
Testing
The end-to-end suite calls the real YouTube InnerTube and Google Video boundaries. It covers search, transcripts, comments, channels, MCP tools, CLI commands, download modes, clipping, resumable ranges, and ffmpeg output streams.
pytest tests/test_e2e.py -v
Limitations
- Private, members-only, and most age-restricted content is unavailable without authentication.
- InnerTube endpoints and renderer structures can change without notice.
- Channel uploads currently return the first available page.
- Adaptive full-video downloads and clipping use the bundled FFmpeg executable (or
YTAI_FFMPEG_PATHwhen configured). - Playlist contents are not currently fetched.
Credits
YTAI acknowledges these public projects as references for protocol details, format mappings, and implementation ideas:
License
MIT, as declared in pyproject.toml.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file youtube_ai-0.2.3.tar.gz.
File metadata
- Download URL: youtube_ai-0.2.3.tar.gz
- Upload date:
- Size: 50.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
13cb9066ab3a4cc6a97fe07df3682e77d9b169e3fb3bf2f42919d3caafd6cc10
|
|
| MD5 |
ed0c7453611fadd6e151fc31719fab5f
|
|
| BLAKE2b-256 |
e7d2fa48b2cef218f36e3d797a4b1fecbdbe34295fe65be1df23fefcc765539f
|
File details
Details for the file youtube_ai-0.2.3-py3-none-any.whl.
File metadata
- Download URL: youtube_ai-0.2.3-py3-none-any.whl
- Upload date:
- Size: 44.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7231824d252297ec7f250f130ae4cd5cb1ae6fade9da817a0a310078510eaf8a
|
|
| MD5 |
32d6e1f08bc7e236b20a00b09c2928d5
|
|
| BLAKE2b-256 |
39abd8c320c34b31258ab0f79d9bc5e825a894b0899f1b9ca348737bb3653197
|