subipranuvem/youtube_transcript_api repository overview

⁠Basic Documentation for Docker Image of FastAPI YouTube Transcript API

This Docker image contains an API built in Python using FastAPI, allowing users to retrieve transcripts from YouTube videos given a video ID or URL.

⁠Running the Container

By default, the API runs on port 8000. To start the container with default settings:

docker run -d -p 8000:8000 subipranuvem/youtube_transcript_api:latest

To change the default port, set the PORT environment variable:

docker run -d -p 8001:8001 -e PORT=8001 subipranuvem/youtube_transcript_api:latest

⁠Using the API

⁠Available Endpoint:

GET /youtube/transcript

⁠Query Parameters:

Note: At least one of the parameters (video_id or video_url) must be provided.

⁠Interactive Documentation

After running the container, access the interactive Swagger UI documentation at the /docs route:

http://localhost:8000/docs

(or replace with your configured port)

⁠Request Example

curl -X GET "http://localhost:8000/youtube/transcript?video_url=https://www.youtube.com/watch?v=dQw4w9WgXcQ&preferred_languages=pt" -H "accept: application/json"