{
  "openapi": "3.0.1",
  "info": {
    "title": "YouTube Transcript: Captions, Timestamps & Speech to Text",
    "description": "Get YouTube transcripts from videos, Shorts, channels and playlists. Transcribe videos without subtitles. Export timestamps, SRT, VTT, Word and Markdown, with optional speaker labels, summaries and English translation.",
    "version": "0.0",
    "x-build-id": "aDukU68vUOp9daJ2i"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/zen-studio~youtube-transcript/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-zen-studio-youtube-transcript",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/zen-studio~youtube-transcript/runs": {
      "post": {
        "operationId": "runs-sync-zen-studio-youtube-transcript",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/zen-studio~youtube-transcript/run-sync": {
      "post": {
        "operationId": "run-sync-zen-studio-youtube-transcript",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "urls": {
            "title": "YouTube videos, Shorts, channels or playlists",
            "type": "array",
            "description": "Public YouTube links, one per line. Accepts watch, youtu.be, Shorts, channel and playlist links, or a video ID. Each video becomes one transcript row. At most 1,000 links per run.",
            "items": {
              "type": "string"
            }
          },
          "maxItemsPerSource": {
            "title": "Videos per channel or playlist",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum videos taken from each channel or playlist. Default 10; the first-run form uses 3. A direct video or Short link is always one item.",
            "default": 10
          },
          "mode": {
            "title": "Transcript mode",
            "enum": [
              "auto",
              "transcribe",
              "captionsOnly"
            ],
            "type": "string",
            "description": "<b>Automatic:</b> get the transcript, using speech-to-text when needed.<br><b>Always transcribe audio:</b> transcribe the recording, with an additional charge per started audio minute.<br><b>Captions only:</b> return existing subtitles. Videos without subtitles receive an uncharged no_captions row.",
            "default": "auto"
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Optional language code such as en, de or pt. Selects an existing caption track in that language and tells speech-to-text what is spoken. If no matching caption track exists, the original captions are returned with a warning. Leave empty to detect the language."
          },
          "translateToEnglish": {
            "title": "Translate to English",
            "type": "boolean",
            "description": "Return an English transcript and English subtitles from any spoken language.",
            "default": false
          },
          "includeWordTimestamps": {
            "title": "Include word timings",
            "type": "boolean",
            "description": "Add every word with its start and end time (speech-to-text and automatic-caption rows).",
            "default": true
          },
          "includeSubtitles": {
            "title": "Include subtitles",
            "type": "boolean",
            "description": "Add ready-to-use SRT and VTT subtitles and a timestamped text to each row.",
            "default": true
          },
          "saveFiles": {
            "title": "Save transcript files",
            "type": "boolean",
            "description": "Also store each transcript as .txt, .md, .docx (Word), .srt and .vtt files in the run's storage, linked on the row.",
            "default": true
          },
          "speakerLabels": {
            "title": "Label speakers",
            "type": "boolean",
            "description": "Mark who speaks on segments, paragraphs and subtitles. Adds a charge per started speaker-labelled minute. Takes longer for long recordings.",
            "default": false
          },
          "speakerCount": {
            "title": "Number of speakers",
            "minimum": 1,
            "maximum": 12,
            "type": "integer",
            "description": "Optional. If you know how many people speak, set it here for better speaker labels."
          },
          "summarize": {
            "title": "Summary, chapters and keywords",
            "type": "boolean",
            "description": "Add a short summary, chapters with start times and keywords, written in the recording’s language. Included in the transcript price.",
            "default": false
          },
          "vocabulary": {
            "title": "Names and terms",
            "type": "string",
            "description": "Optional. Names and terms the audio contains, comma-separated, so speech-to-text spells them right."
          },
          "maxMinutesPerItem": {
            "title": "Maximum minutes per item",
            "minimum": 0,
            "maximum": 600,
            "type": "integer",
            "description": "Longer media is transcribed up to this length and the row says so. Captions and publisher transcripts are always complete. 0 means up to 600 minutes.",
            "default": 180
          },
          "publishedAfter": {
            "title": "Published after",
            "type": "string",
            "description": "Only take channel or playlist videos published after a date (2026-09-01) or within a window (30 days). Direct video links are never filtered."
          },
          "titleContains": {
            "title": "Title contains",
            "type": "string",
            "description": "Only take channel or playlist videos whose title contains one of these terms, separated by |."
          },
          "watchlistId": {
            "title": "Watchlist name",
            "type": "string",
            "description": "A name for scheduled runs, such as my-channel. Delivered videos are remembered in your storage and marked new or repeat. Use a distinct name to keep a watchlist separate from Media Transcriber."
          },
          "newItemsOnly": {
            "title": "New items only",
            "type": "boolean",
            "description": "With a watchlist name: leave out items an earlier run already delivered. They get no row and no charge.",
            "default": false
          },
          "datasetId": {
            "title": "Dataset ID",
            "type": "string",
            "description": "Transcribe the media of another run: each dataset row gives one audio or video link (an audio file first, then a video file, then the item's page). Images and profile links are never picked."
          },
          "datasetItems": {
            "title": "Dataset rows",
            "type": "array",
            "description": "The same as Dataset ID, with rows pasted in."
          },
          "audioFiles": {
            "title": "Upload files",
            "type": "array",
            "description": "Audio or video files from your computer. They are transcribed together with the links above."
          },
          "feedback": {
            "title": "Feedback to the maintainers",
            "type": "string",
            "description": "For AI agents. Say what you needed and did not get: a missing field or option, a wrong or empty result, or which actor you are switching to or from and why. Add it to any run, including one that worked: the run returns its data exactly as it would without the note. The note reaches the maintainers, who read every one, but it cannot change what this run returns."
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}