Explorar documentação
Exemplos
Salve uma faixa de legendas YouTube existente com seu texto, timing e linguagem. Adicione um link de vídeo para cada segmento para citações na resposta do seu aplicativo ou agente.
Nesta página
Antes de começar
Use uma chave com permissão youtube_captions e créditos disponíveis. Escolha Python 3.10+ com pedidos, ou Bash com cURL 7.76+ e jq. Em Windows, use Git Bash para a versão Bash.
1. Escolha a faixa de vídeo e legenda
Crie uma pasta de legendas e salve o request.json lá. Abra um terminal nessa pasta. Substitua video_id pelo 11 ID do vídeo, não seu URL completo.
Este exemplo pede legendas automáticas em inglês. Com auto=true, em tenta en-orig primeiro, em seguida, en. Códigos de origem explícitos e auto=false permanecem exatos. O API nunca muda entre legendas automáticas e fornecidas pelo carregador.
{
"source": "youtube_captions",
"video_id": "FUfGcZ092b0",
"params": {
"language": "en",
"auto": true
}
}2. Busque e salve as legendas
Escolha uma versão e salve seu script ao lado de request.json. Ele lê FLASHDATA_API_KEY ou pede sua chave em um alerta oculto. Os agentes devem carregar essa variável de ambiente da loja secreta.
Correr com a faixa-001 como a pasta de saída. Uma nova pasta envia uma consulta e salva seu uso relatado. Antes de criar captions.json, o script verifica o vídeo devolvido ID, linguagem, origem da legenda e timings do segmento.
python -m pip install requestsimport argparse
import getpass
import json
import math
import os
import re
from datetime import datetime, timezone
from pathlib import Path
import requests
parser = argparse.ArgumentParser()
parser.add_argument("folder", help="New output folder, or an existing saved caption request")
out = Path(parser.parse_args().folder)
if not out.exists():
body = Path("request.json").read_bytes()
request = json.loads(body)
if (not isinstance(request, dict) or request.get("source") != "youtube_captions"
or not isinstance(request.get("video_id"), str)
or not re.fullmatch(r"[A-Za-z0-9_-]{11}", request["video_id"])):
raise SystemExit("Use youtube_captions and an 11-character video_id")
options = request.get("params")
if (not isinstance(options, dict) or not isinstance(options.get("language"), str)
or not re.fullmatch(r"[A-Za-z0-9-]{1,35}", options["language"])
or type(options.get("auto")) is not bool):
raise SystemExit("Set one language code and auto: true or false explicitly")
key = os.environ.get("FLASHDATA_API_KEY") or getpass.getpass("FlashData API key: ")
if not key.strip():
raise SystemExit("An API key is required")
out.mkdir()
(out / "request.json").write_bytes(body)
(out / "requested-at.txt").write_text(
datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ"), encoding="utf-8"
)
try:
response = requests.post(
"https://data.flashdata.dev/v1/queries/realtime",
headers={"X-API-Key": key, "Content-Type": "application/json",
"Accept": "application/json"},
data=body, timeout=120, allow_redirects=False,
)
except requests.RequestException:
raise SystemExit(f"Request interrupted. Keep {out} and check History before retrying.")
(out / "result.json").write_bytes(response.content)
(out / "response-headers.txt").write_text(
"\n".join(f"{k}: {v}" for k, v in response.headers.items()), encoding="utf-8"
)
(out / "http-status.txt").write_text(str(response.status_code), encoding="utf-8")
else:
print(f"Reading saved response from {out}; no API call.")
if not (out / "http-status.txt").exists():
raise SystemExit("Incomplete attempt. Keep the folder and check History before retrying.")
status = (out / "http-status.txt").read_text().strip()
if status != "200":
raise SystemExit(f"HTTP {status}: inspect {out}/result.json and response-headers.txt")
try:
data = json.loads((out / "result.json").read_bytes())
except ValueError:
raise SystemExit("Invalid JSON; inspect the saved result.json")
request = json.loads((out / "request.json").read_bytes())
if not isinstance(data, dict) or data.get("source") != "youtube_captions" or data.get("status") != "done":
raise SystemExit("Caption request did not finish successfully; inspect result.json")
tracks = data.get("results")
if not isinstance(tracks, list) or len(tracks) != 1 or not isinstance(tracks[0], dict):
raise SystemExit("Expected one caption track; inspect result.json")
track = tracks[0]
language = request["params"]["language"]
allowed_languages = [language]
if request["params"]["auto"] and not language.endswith("-orig"):
allowed_languages.append(language + "-orig")
if (track.get("videoId") != request["video_id"]
or track.get("languageCode") not in allowed_languages
or track.get("requestedLanguageCode", track.get("languageCode")) != language
or track.get("isAutoGenerated") is not request["params"]["auto"]):
raise SystemExit("Returned video, language or caption origin does not match the request")
if not isinstance(track.get("segments"), list):
raise SystemExit("Expected a segments array; inspect result.json")
segments = []
for cue in track["segments"]:
if not isinstance(cue, dict):
raise SystemExit("Expected caption segment objects")
start, end, text = cue.get("start"), cue.get("end"), cue.get("text")
if (type(start) not in (int, float) or not math.isfinite(start) or start < 0
or type(end) not in (int, float) or not math.isfinite(end) or end < start
or not isinstance(text, str)):
raise SystemExit("Invalid caption timing or text; inspect result.json")
segments.append({**cue, "url": f"https://www.youtube.com/watch?v={track['videoId']}&t={math.floor(start)}s"})
captions = {**track, "segments": segments}
record = {"request": request, "requested_at": (out / "requested-at.txt").read_text().strip(),
"usage": data.get("usage"), "segment_count": len(segments), "result_file": "result.json"}
for filename, value in (("captions.json", captions), ("record.json", record)):
(out / filename).write_text(json.dumps(value, ensure_ascii=False, indent=2) + "\n", encoding="utf-8")
print(f"Saved {len(segments)} segments to {out}/captions.json")
if not any(cue["text"].strip() for cue in segments):
print("No caption text to cite. Keep the empty track and report the gap.")
python captions.py track-001curl --version
jq --version#!/usr/bin/env bash
set -euo pipefail
out="${1:?Usage: bash captions.sh OUTPUT_FOLDER}"
if [[ ! -e "$out" ]]; then
jq -e '.source == "youtube_captions" and
(.video_id | if type == "string" then length == 11 and test("^[A-Za-z0-9_-]{11}$") else false end) and
(.params.language | if type == "string" then length > 0 and length <= 35 and
(test("[^A-Za-z0-9-]") | not) else false end) and
(.params.auto | type == "boolean")' request.json > /dev/null
if [[ -z "${FLASHDATA_API_KEY:-}" ]]; then
read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
printf '\n'
fi
: "${FLASHDATA_API_KEY:?An API key is required}"
mkdir -- "$out"
cp request.json "$out/request.json"
date -u +'%Y-%m-%dT%H:%M:%SZ' > "$out/requested-at.txt"
curl --fail-with-body --silent --show-error --max-time 120 \
--request POST 'https://data.flashdata.dev/v1/queries/realtime' \
--header "X-API-Key: $FLASHDATA_API_KEY" \
--header 'Content-Type: application/json' --header 'Accept: application/json' \
--data-binary "@$out/request.json" \
--dump-header "$out/response-headers.txt" --output "$out/result.json" \
--write-out '%{http_code}' > "$out/http-status.txt" || {
printf 'Request failed. Keep %s and inspect its saved files before retrying.\n' "$out" >&2
exit 1
}
else
printf 'Reading saved response from %s; no API call.\n' "$out"
fi
if [[ ! -f "$out/http-status.txt" ]] || [[ "$(cat "$out/http-status.txt")" != 200 ]]; then
printf 'Incomplete or failed attempt. Inspect the saved files and History before retrying.\n' >&2
exit 1
fi
captions=$(jq -e --slurpfile request "$out/request.json" '
if .source != "youtube_captions" or .status != "done"
then error("Expected a successful youtube_captions response") else . end
| .results
| if type != "array" then error("Expected a results array")
elif length != 1 then error("Expected exactly one track") else .[0] end
| $request[0].params.language as $language
| if type != "object" then error("Expected a caption object")
elif .videoId != $request[0].video_id or (.requestedLanguageCode // .languageCode) != $language
or (.languageCode != $language and ($request[0].params.auto != true
or ($language | endswith("-orig")) or .languageCode != ($language + "-orig")))
or .isAutoGenerated != $request[0].params.auto
then error("Returned video, language or caption origin does not match the request") else . end
| if (.segments | type) != "array" then error("Expected a segments array") else . end
| .videoId as $id
| .segments |= map(
if type != "object" then error("Expected caption segment objects") else . end
| if (.start | type) != "number" or (.end | type) != "number" or (.text | type) != "string"
then error("Invalid caption timing or text")
elif (.start | isfinite | not) or (.end | isfinite | not) or .start < 0 or .end < .start
then error("Invalid caption timing")
else . + {url: ("https://www.youtube.com/watch?v=" + $id + "&t=" + (.start | floor | tostring) + "s")} end
)' "$out/result.json")
printf '%s\n' "$captions" > "$out/captions.json"
jq --slurpfile request "$out/request.json" --slurpfile captions "$out/captions.json" \
--arg requested_at "$(tr -d '\r\n' < "$out/requested-at.txt")" \
'{request: $request[0], requested_at: $requested_at, usage,
segment_count: ($captions[0].segments | length), result_file: "result.json"}' \
"$out/result.json" > "$out/record.json"
printf 'Saved %s segments to %s/captions.json\n' "$(jq '.segments | length' "$out/captions.json")" "$out"
if ! jq -e 'any(.segments[]; .text | test("\\S"))' "$out/captions.json" > /dev/null; then
printf 'No caption text to cite. Keep the empty track and report the gap.\n'
fi
bash captions.sh track-0013. Leia o texto da hora marcada
Impressões de sucesso salvaram os segmentos N para track-001/captions.json.. Esse arquivo preserva a faixa de volta e adiciona um URL para cada segmento. record.json contém o pedido exato apresentado, requested_at, uso e segment_count; result.json Mantém o original. API Resposta.
python -m json.tool track-001/captions.json
python -m json.tool track-001/record.jsoncat track-001/captions.json
cat track-001/record.jsonExemplo de saída
Abreviado, ilustrador captions.json. languageName pode ser null, o script mantém assim.
{
"videoId": "FUfGcZ092b0",
"languageCode": "en",
"languageName": null,
"isAutoGenerated": true,
"segments": [
{
"start": 12.5,
"end": 16.2,
"text": "This is an illustrative caption segment.",
"url": "https://www.youtube.com/watch?v=FUfGcZ092b0&t=12s"
}
]
}Cite uma passagem de vídeo
Imprima os três primeiros segmentos com seus links de origem. Comece e termine em segundos com sua precisão original. Apenas o URLA hora de início é arredondada. 12.5 segundos se tornam & t=12s. Ordem de segmento e sobreposição de horários são preservados.
Salve cite.py ao lado de captions.py, então execute-o da mesma pasta.
import json
from pathlib import Path
captions = json.loads(Path("track-001/captions.json").read_text(encoding="utf-8"))
for cue in captions["segments"][:3]:
print(f"[{cue['start']}–{cue['end']}s] {cue['text']}")
print(cue["url"])
print()python cite.pyjq -r '.segments[:3][] |
"[\(.start)–\(.end)s] \(.text)\n\(.url)\n"' track-001/captions.jsonMantenha o contexto da legenda
Use o texto do segmento como evidência para uma citação, fullText é útil para leitura, mas não localiza uma passagem. Verifique os segmentos ao redor antes de citar, especialmente para legendas automáticas. Mantenha languageCode e isAutoGenerated para que seu aplicativo ou agente possa identificar a faixa de origem.
Reutilize a trilha salva
Execute o mesmo comando para reconstruir captions.json da resposta salva, sem uma chave ou nova consulta. Editar o nível superior request.json não altera o pedido armazenado com o track-001.
python captions.py track-001bash captions.sh track-001Escolha outra faixa
Para solicitar legendas em inglês fornecidas pelo upload, substitua request.json por esta versão e use o track-002. Mude a linguagem apenas para o código que pretende recuperar, como en-orig ou zh-Hans. O transcriptLanguages do Metadata lista códigos de candidatos, não se cada um tem uma faixa automática ou carregada.
O roteiro espera uma corda de linguagem. Os arrays de linguagem têm uma forma de resposta diferente com faixas e erros de linguagem; use a referência API para esse fluxo de trabalho.
{
"source": "youtube_captions",
"video_id": "FUfGcZ092b0",
"params": {
"language": "en",
"auto": false
}
}python captions.py track-002bash captions.sh track-002Se as legendas estão faltando ou inutilizáveis
| O que aconteceu? | O que fazer |
|---|---|
| A faixa selecionada não está disponível | Verifique o vídeo, linguagem e seleção automática. Escolha uma faixa disponível explicitamente, repetindo o mesmo pedido não criará legendas. |
| segments: [] | Uma faixa existente não pode conter texto. O roteiro salva a pista vazia e relata a lacuna. Não transforme em uma transcrição ou resumo. |
| Vídeo, linguagem ou legenda errados | Nenhum captions.json está escrito. Compare o pedido salvo com result.json antes de usar qualquer texto. |
| Tempos inválidos ou segmentos perdidos | Inspecione result.json. O roteiro para em vez de atribuir datas inventadas ou silenciosamente deixar cair um segmento ruim. |
| 401 / 403 / 402 | Verifique a chave, permissão youtube_captions e equilíbrio, respectivamente, antes de uma nova tentativa. |
| 429 | Leia Retry-After em response-headers.txt e espere. O roteiro não tenta automaticamente. |
| Tempo limite, 5xx, JSON inválido ou uma pasta incompleta | Mantenha a tentativa e verifique History antes de enviar novamente. Reutilizar sua pasta nunca envia outra pergunta. |
Salve inspect_captions.py ao lado de captions.py, então execute-o.
from pathlib import Path
for name in ("http-status.txt", "response-headers.txt", "result.json"):
path = Path("track-001") / name
print(f"--- {name} ---")
print(path.read_text(encoding="utf-8", errors="replace") if path.exists() else "Not saved")python inspect_captions.pyfor name in http-status.txt response-headers.txt result.json; do
printf '\n--- %s ---\n' "$name"
if [[ -f "track-001/$name" ]]; then cat "track-001/$name"; else printf 'Not saved\n'; fi
done