Przeglądaj dokumentację
Dokumentacja API
YouTube Captions API
Pobierz podpisy YouTube jako oznaczony terminowo tekst i pełny zapis. Podpisy dostarczane przez uploader- są domyślnie wybierane.
Utwórz żądanie
11- znak ID z wideo URL, a nie pełny URL.
Zostaw puste, aby spróbować en- orig, a następnie en, i zwrócić jeden utwór. Albo wprowadź jeden kod lub do 10 kody odrębne oddzielone przecinkami.
https://data.flashdata.dev/v1/queries/realtimeParametry
Wyślij source oraz video_id na najwyższym poziomie. Opcje źródłowe należą do params. Można pominąć pola opcjonalne.
Treść żądania
sourcestring / Wymagane- Ustaw na youtube_captions.
video_idstring / Wymagane- 11- znak YouTube wideo ID, takich jak FUfGcZ092b0. Akceptuje litery, liczby, podkreślenia i mifeny.Dokładnie 11 znakiDomyślnie:
NieustawioneFormat zaakceptowany
^[A-Za-z0-9_-]{11}$ paramsobject / Opcjonalne- Settings dla tego wniosku.Domyślnie:
{} callback_urlstring · nullable / Opcjonalne- Async i tylko partia. Publiczne ukończenie HTTPS URL na porcie 443, do znaków 2,048. Brak danych uwierzytelniających użytkownika lub fragmentu URL. Omit, użyj null lub pustego łańcucha bez powiadomienia. W partii, ustawić to na każdym zapytaniu, na zewnątrz params.Domyślnie:
Nieustawione
Wybór podsumowujący
params.languagestring | array / Opcjonalne- Omit for English (en- orig, then en). Z auto = true, każdy kod najpierw próbuje jego -orig tor, a następnie żądany kod. Kody explicit -orig i auto = false pozostają dokładne. 1–10 żąda różnych języków.Domyślnie:
en-orig → en params.autoboolean / Opcjonalne- true wybiera podpisy wygenerowane przez YouTube-; false wybiera podpisy dostarczone przez uploadera. Wybiera pochodzenie zapisu, nie wykrywanie języka ani nowe transkrypcje.
truelubfalseDomyślnie:false
Odpowiedź
Realtime zwraca status: done. Odczytaj wyjście źródłowe w results[0]; usage.credits Zapisuje zarzuty.
Odczytywanie segmentów dla tekstu napisy z start/end razy w sekundach i fullText dla tekstu łączonego. languageCode i isAutoGenerated raportować wybrany utwór.
Przeczytaj wynik
Zapisz udane odpowiedzi JSON jako response.json. Zapisz to jako read-response.py i uruchom python read-response.py. Wykorzystuje tylko standardową bibliotekę Python i nie składa nowego wniosku.
import json
from pathlib import Path
response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
print("[]")
raise SystemExit(0)
result = response["results"][0]
output = {
"tracks": result.get("tracks", [result]),
"errors": result.get("errors", []),
}
print(json.dumps(output, ensure_ascii=False, indent=2))Omit język preferować en- orig i wrócić do en, zwracając jeden utwór. Z auto = true, każdy żądany kod preferuje swoją ścieżkę -orig, a następnie prosty kod; wyraźny -orig i auto = false pozostają dokładne. Nagrania wypróbowuj każdy żądany język, a następnie zwróć ścieżki i błędy w kolejności. languageCode identyfikuje wybraną ścieżkę; requestedLanguageCode jest dołączony, gdy jest różna.
W przypadku tablic języków pole errors wskazuje ścieżki, których nie udało się pobrać. Jeśli nie pobrano żadnej ścieżki, żądanie kończy się błędem, a zarezerwowane kredyty są zwracane. Błąd ekstrakcji wideo lub przekroczenie limitu czasu również powoduje niepowodzenie żądania.
Domyślne auto do false dla podręcznego zapisu. Ustaw true na automatyczne podpisy. API nigdy nie włącza źródeł napisu.
API odczytuje istniejące podpisy YouTube; nie generuje nowych transkrypcji. Domyślna odpowiedź zawiera znormalizowane segmenty JSON; Accept może wybrać zwykły tekst, a X-Respond-With: wybieranie znaczników Markdown. languageName może być null; czas segmentu są zachowane.
Wiele języków
Wyślij tablicę językową, aby odbierać utwory i błędy związane z językiem potocznym. Ten przykład pokazuje angielski dostępny i hiszpański niedostępny.
{
"source": "youtube_captions",
"video_id": "jNQXAC9IVRw",
"params": {
"language": [
"en",
"es"
],
"auto": false
}
}{
"videoId": "jNQXAC9IVRw",
"isAutoGenerated": false,
"tracks": [
{
"videoId": "jNQXAC9IVRw",
"languageCode": "en",
"languageName": null,
"isAutoGenerated": false,
"segments": [
{
"start": 0,
"end": 1.5,
"text": "Hello world."
}
],
"fullText": "Hello world."
}
],
"errors": [
{
"languageCode": "es",
"code": "language_unavailable",
"message": "Uploader-provided subtitles not available for language: es"
}
]
}Wszystkie pola odpowiedzi
| Pole | Opis |
|---|---|
sourcestring | Żądane źródło API. |
statusstring | zrobić, gdy realtime wniosek się powiedzie. |
created_atstring | Czas tworzenia odpowiedzi w formacie ISO 8601. |
usage.creditsnumber | Zasługi naliczane za wniosek, w oparciu o twój plan. |
results[0].videoIdstring | Wymagany film wideo ID. |
results[0].languageCodestring | Faktyczny wybrany kod utworu podręcznego, np. en- orig. |
results[0].languageNamestring · nullable | Nazwa wyświetlacza językowego, gdy jest dostępna. |
results[0].requestedLanguageCodestring · optional | Wymagany kod, gdy różni się od languageCode, na przykład en, kiedy en- orig został wybrany. |
results[0].isAutoGeneratedboolean | Czy zaznaczone podpisy były generowane automatycznie. |
results[0].segmentsarray | Segmenty nagraniowe w porządku chronologicznym. |
results[0].segments[].startnumber | Segment zaczyna się za kilka sekund. |
results[0].segments[].endnumber | Czas zakończenia segmentu w sekundach. |
results[0].segments[].textstring | Tekst z napisu. |
results[0].fullTextstring | Wszystkie teksty segmentu połączone z transkrypcją. |
results[0].tracksarray · optional | Tylko dla tablic językowych. Dostępne utwory w kolejności zapytania; każda z nich posiada pola o pojedynczym torze wymienione powyżej. |
results[0].errorsarray · optional | Tylko dla tablic językowych. Nieudane języki w zamówieniu. Puste, gdy każdy utwór się powiedzie. |
results[0].errors[].languageCodestring | Żądany język, który się nie powiódł. |
results[0].errors[].codestring | language_unavailable, gdy wybrana ścieżka nie istnieje; retrieval_failed, gdy nie można jej pobrać ani przeforsować. |
results[0].errors[].messagestring | Opis niesprawności językowej. |
Powyższe pola opisują domyślną odpowiedź JSON. Formaty JSON, proste teksty i Markdown.
Async zwraca jeden pokwitowanie zadania; partia zwraca jeden na wideo ID. Sprawdź status każdego zadania i odzyskaj jego wyniki za pomocą zwróconych linków.
Async i cykl życia serii
Składanie zwraca pokwitowanie, nie wyniki. Async tworzy jedno zadanie; wsadowe zwraca osobne zadanie w queries[] dla każdego akceptowanego zapytania. Śledź i odzyskaj każdą pracę niezależnie.
Prześlij do data.flashdata.dev; odczyt statusu pracy i wyniki api.flashdata.dev z tym samym X-API-Key. API podstawowe przykłady używać Python i cURL.
1. Zapisz zadanie IDs
Podczas przełączania na Async należy zachować pola żądania tego źródła. Dla Batch, umieścić każde żądanie wewnątrz tablicy zapytań obiektu JSON. Zapisz każdą zwróconą pracę ID.
2. Sprawdź status
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: ankieta z opóźnieniem i szacunkiemRetry-Aftergdy jest obecny.completed: pobrać wyniki.failed: Kontrolajob.error.Przeczytaj job.status, a nie status potwierdzenia zgłoszenia.
Sprawdź status · Python i cURL
Status zatrudnienia API3. Wyniki pobierania
GET https://api.flashdata.dev/v2/jobs/{jobId}/resultsPo zakończeniu, uwierzytelnić wynik odczytywany, a następnie pobrać 302 pamięci URL bez klucza API. Zapisać JSON w ciągu 24 godzin po zakończeniu.
Wyniki pobierania · Python i cURL · Formaty odpowiedzi
Wynik pobrania API reference
Sondaże i pobieranie istniejących wyników nie zużywają kredytów zapytania. Czas ankiety nie anuluje zadania: zachować ID zamiast przedkładania duplikatu pracy billable. Kody błędów i powtarzanie zachowania.
Webhooki zakończenia
Subskrybuj na zapytanie
Ustaw callback_url na najwyższym poziomie żądania async, lub wewnątrz każdego zapytania w partii, na zewnątrz params. Nie jest wymagany oddzielny wniosek o rejestrację webhook- rejestracji. Żądania Realtime nie wysyłają zwrotów.
Użyj publicznego HTTPS URL na porcie 443. FlashData POST powiadomienie dla każdego zadania osiągającego completed lub failed; zdarzenie zawiera linki, a nie sam wynik.
Potwierdzenie i weryfikacja
Powrót 2xx po trwałym przyjęciu wydarzenia. Kopiowanie według delivery_id, również wysłane jako X-Delivery-Id. Przekierowanie nie jest przestrzegane.
Nieudane dostawy ponownie spróbować z wykładniczym backupu, aż do 8 próbuje w sumie i co najwyżej 24 godziny po zakończeniu. Kontynuuj sondaże jako zapas.
Przekazy są niepodpisane. Potwierdź zadanie ID, źródło i status terminala poprzez Uwierzytelniony punkt końcowy stanu przed rozpatrzeniem powiadomienia. Dostawa ID jest dla dedukcji, a nie dowód autentyczności.
Przykład zdarzenia i pól haka webowego
{
"delivery_id": "completion:job_example0001",
"id": "job_example0001",
"source": "youtube_captions",
"status": "completed",
"links": [
{
"rel": "self",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001",
"method": "GET"
},
{
"rel": "results",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
"method": "GET"
}
]
}| Pole | Opis |
|---|---|
delivery_idstring | Stabilny identyfikator dostawy. Notyfikacje kopiujące przy użyciu tej wartości; jest również wysyłane w nagłówku X-Delivery-Id. |
idstring | Job ID. |
sourcestring | Wymagane źródło danych. |
statusstring | ukończone lub nie. |
linksarray | Powiązania stanu i wyników. Powiadomienia nie zawierają treści wyników ani klucza API. |
links[].relstring | siebie lub wyników. |
links[].hrefstring | Absolute Management API URL; uwierzytelniaj kluczykiem API. |
links[].methodstring | GET. |
Przetwarzanie plików Bulk
Wyślij jeden film ID na linię i utwórz zadanie Bulk ze źródłem: youtube_captions. Wspólne opcje odnoszą się do każdego ID w pliku.
Opcje źródłowe: language, auto. Umieść je w opcjach podczas tworzenia zadania Bulk.
Pobieranie zakończonej kolekcji jako części wyjściowe z widocznym i skompresowanym gzip NDJSON. Źródła danych mogą również dostarczać części wyników do pamięci masowej w chmurze poprzez ustawienie options.result_storage podczas tworzenia zadania Bulk. Zapisz manifest i części w ciągu 24 godzin po zakończeniu całego zadania Bulk.
Bulk przetwarzanie API · Python i cURL · Batch JSON wnioski
Zbuduj przepływ pracy Bulk dla tego źródła · Wstrzymać, wznowić i odzyskać
Błąd przy odzyskiwaniu
Film może mieć automatyczne podpisy, ale nie ma ręcznego toru, lub brak języka, o który się zwrócono. Sprawdź dostępność podpisy za pomocą metadanych i wybierz język i pochodzenie celowo przed nowym złożeniem.
Sprawdź dostępne języki napisy w metadanych. Nowa prośba korzysta z kredytów zapytania; zmiana ścieżki nie zmienia istniejącego zadania.
W przypadku błędów w uwierzytelnianiu, równowadze, formacie request- format i limicie rate- limit, użyj współdzielonego odniesienia błędu. Czas składania może jeszcze utworzyć pracę; sprawdzić istniejącą pracę przed ponownym uruchomieniem.
Błędy i kody statusu · Kiedy spróbować ponownie · Limity stóp procentowych
Przewodnik po krokach: Pobieranie napisów z terminami
Cennik
| Plany | Wskaźniki stosowaniaza 1 000 standardowych żądań | Subskrypcje | Zawarte kredyty na okres rozliczeniowy |
|---|---|---|---|
| Płatność za użycie | 0,50 USD | Bez opłaty miesięcznej | Doładuj w razie potrzeby |
| Micro | 0,40 USD | 49,00 USD / miesiąc | Kredyty 1000 (50,00 USD wykorzystania API) włączone do |
| Starter | 0,35 USD | 199,00 USD / miesiąc | Kredyty 4000 (200,00 USD wykorzystania API) włączone do |
| Pro | 0,30 USD | 499,00 USD / miesiąc | Kredyty 10 000 (500,00 USD wykorzystania API) włączone do |
| Scale | 0,25 USD | 999,00 USD / miesiąc | Kredyty 20 000 (1000,00 USD wykorzystania API) włączone do |
| Business | 0,20 USD | 1999,00 USD / miesiąc | Kredyty 40 000 (2000,00 USD wykorzystania API) włączone do |
Jeden plan konta. Wspólne kredyty dla trzech produktów. Użycie pokryte kredytami w planie nie jest naliczane ponownie.
Ceny bieżące i limity dotyczące planów