Quickstart

You need a key from the dashboard and a video whose captions are public. New accounts hold 100 credits, which is enough to work through this page about twenty times over.

A schema is a list of columns, each with a name and a plain-language description. The description is the instruction, so write it the way you would brief a person.

// no SDK needed — plain fetch
const res = await fetch("https://api.tubeextract.dev/v1", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.TUBEEXTRACT_KEY,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    // always a list — one video here, up to 200 in the same call
    videos: ["https://youtube.com/watch?v=dQw4w9WgXcQ"],
    schema: {
      multiple: true,
      columns: [
        { name: "city",
          description: "A city the speaker mentions visiting" },
        { name: "timestamp",
          description: "When it is mentioned, as hh:mm:ss" }
      ]
    }
  })
});
 
const job = await res.json();
console.log(job.job_id); // 8f2c1e40-91a3-4b7e

Request body

Extraction is asynchronous, so the submit call answered with an id rather than rows. Poll every two seconds, or supply a webhook_url and skip polling entirely. A single video usually settles in twelve to fifteen seconds.

results stays null until every video in the job has settled, so polling is free and destroys nothing.

Every job settles into one of these. Treat anything else as a transport error and retry with the same idempotency key.