Run batch

runBatch(params, options?): BatchResponse

POST/v1/batch1 Credit

Each task runs in isolation. The batch itself does not fail as a whole: inspect success on every result. You are billed 1 credit per successful task.

Security

API Token

The preferred authorization scheme for the YouTube Transcript API. Create a key with transcripts:read in the developer dashboard.

Example: Authorization: Bearer YOUR_API_KEY

See Authentication for scopes and rate limits.

Accepted permissions (at least one required)

transcripts:read

ParametersExpand Collapse

tasks:BatchTask[]

Body param:

Up to 10 task objects.

id?:string

Caller-defined id echoed on the result.

type:string

transcript or video_info.

video_id:string

11-character YouTube video ID.

format?:string

Transcript format when type is transcript.

mode?:string

Video lookup mode when type is video_info (fast or full).

ReturnsExpand Collapse

total_tasks:number

Number of tasks submitted.

successful_tasks:number

Tasks with "success": true.

failed_tasks:number

Isolated failures (missing captions, invalid ids).

total_latency_ms:number

Wall-clock time for the whole batch.

results:BatchResult[]

Per-task outcome, including id, video_id, type, success, latency_ms, and data.

Fair credit accounting

Only tasks with "success": true consume credits.

Run batch

const response = await fetch("https://api.ytapi.dev/v1/batch", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.YT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    tasks: [
      {
        id: "task_1",
        type: "transcript",
        video_id: "dQw4w9WgXcQ",
        format: "markdown",
      },
      {
        id: "task_2",
        type: "video_info",
        video_id: "jNQXAC9IVRw",
        mode: "fast",
      },
    ],
  }),
});

const batch = await response.json();
for (const result of batch.results) {
  console.log(result.id, result.success);
}

import os
import requests

response = requests.post(
    "https://api.ytapi.dev/v1/batch",
    headers={"Authorization": f"Bearer {os.environ['YT_API_KEY']}"},
    json={
        "tasks": [
            {"id": "1", "type": "transcript", "video_id": "dQw4w9WgXcQ", "format": "segments"},
            {"id": "2", "type": "transcript", "video_id": "jNQXAC9IVRw", "format": "markdown"},
        ]
    },
)

results = response.json()
for item in results["results"]:
    print(item["id"], item["success"])

curl -X POST https://api.ytapi.dev/v1/batch \
  -H "Authorization: Bearer $YT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tasks": [
      {
        "id": "task_1",
        "type": "transcript",
        "video_id": "dQw4w9WgXcQ",
        "format": "markdown"
      },
      {
        "id": "task_2",
        "type": "video_info",
        "video_id": "jNQXAC9IVRw",
        "mode": "fast"
      }
    ]
  }'

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
	"os"
)

func main() {
	payload, _ := json.Marshal(map[string]any{
		"tasks": []map[string]any{
			{"id": "task_1", "type": "transcript", "video_id": "dQw4w9WgXcQ", "format": "markdown"},
			{"id": "task_2", "type": "video_info", "video_id": "jNQXAC9IVRw", "mode": "fast"},
		},
	})

	req, _ := http.NewRequest("POST", "https://api.ytapi.dev/v1/batch", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer "+os.Getenv("YT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

200 example

{
  "total_tasks": 2,
  "successful_tasks": 2,
  "failed_tasks": 0,
  "total_latency_ms": 348,
  "results": [
    {
      "id": "task_1",
      "video_id": "dQw4w9WgXcQ",
      "type": "transcript",
      "success": true,
      "latency_ms": 312,
      "data": {
        "format": "markdown",
        "markdown": "# Never Gonna Give You Up\n\n[00:00] We're no strangers to love..."
      }
    },
    {
      "id": "task_2",
      "video_id": "jNQXAC9IVRw",
      "type": "video_info",
      "success": true,
      "latency_ms": 84,
      "data": {
        "title": "Me at the zoo",
        "author": "jawed",
        "duration_seconds": 19
      }
    }
  ]
}