Ga naar de inhoud
NL
API-sleutel ophalen
Documentatie bekijken

API-referentie

YouTube Trainability API

Een API-sleutel aanmaken

Controleer de licentiemetadata van een YouTube-video voor een Creative Commons-label en haal het resultaat op als JSON.

Stel een aanvraag samen

De ID van 11 tekens uit de video-URL, niet de volledige URL.

POSThttps://data.flashdata.dev/v1/queries/realtime
Python 3 · requests
python3 -m pip install requests
import json

import requests

api_key = "YOUR_API_KEY"
payload = {
    "source": "youtube_trainability",
    "video_id": "dQw4w9WgXcQ",
}

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": api_key, "Accept": "application/json"},
    json=payload,
    timeout=120,
)
response.raise_for_status()
print(json.dumps(response.json(), ensure_ascii=False, indent=2))
Resultaten in de HTTP-responsX-API-Key-authenticatie

Parameters

Verzenden source en video_id op het bovenste niveau. Deze bron heeft geen bronspecifieke params. Optionele velden kunnen worden weggelaten.

Aanvraaginhoud

sourcestring / Vereist
Instellen op youtube_trainability.
video_idstring / Vereist
De 11-karakter YouTube video ID, zoals FUfGcZ092b0. Accepteert letters, cijfers, onderstrepingen en koppeltekens.
Precies 11 tekensStandaard: Niet ingesteld
Geaccepteerd formaat^[A-Za-z0-9_-]{11}$
callback_urlstring · nullable / Optioneel
Async en alleen batch. Publieke HTTPS voltooiing URL op poort 443, tot 2,048 tekens. Geen gebruikersgegevens of URL-fragment. Gebruik null of een lege tekenreeks zonder melding. In een batch, zet dit op elke query, buiten params.
Standaard: Niet ingesteld

Antwoord

Realtime geeft terug status: done. Lees de bron uitvoer op results[0].permitted; usage.credits neemt de aanklacht op.

Het resultaat echo's videoId en rapporten type, etag en toegestaan. De werknemer controleert het licentielabel van de video: ["all"] voor een gedetecteerd Creative Commons-label, anders ["none"], inclusief ontbrekende licentiemetadata.

Lees het resultaat

Bewaar de succesvolle JSON respons als response.json. Sla dit op als read-response.py en voer python read-response.py uit. Het gebruikt alleen de standaardbibliotheek van Python en doet geen nieuw verzoek.

read-response.py
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 = {"videoId": result.get("videoId"), "permitted": result.get("permitted", [])}
# Keep the label values; this is not a training-rights authorization.
print(json.dumps(output, ensure_ascii=False, indent=2))

Deze bron heeft geen bron-specifieke opties. Stuur video_id op het bovenste niveau; laat params weg.

Dit eindpunt haalt de YouTube trainingsinstellingen van de maker niet terug. Geen van de toegestane waarde verleent opleidingsrechten; het veld is alleen de output van deze licentie-labelcontrole.

Alle responsvelden
VeldOmschrijving
sourcestringDe gevraagde API bron.
statusstringgedaan wanneer het real-time verzoek slaagt.
created_atstringAanmaaktijd voor respons in ISO 8601-formaat.
usage.creditsnumberCredits in rekening gebracht voor het verzoek, op basis van uw plan.
results[0].videoIdstringDe gevraagde video ID.
results[0].kindstringFlashData resultaattype: youtube#videoTrainability.
results[0].etagstringVideo ID echoed als de response tag.
results[0].permittedarray<string>["all"] wanneer een Creative Commons-label wordt gedetecteerd; anders ["none"], ook wanneer licentiemetadata ontbreken. Deze waarden rapporteren niet de YouTube trainingsinstellingen van de maker.

De velden hierboven beschrijven het standaard JSON antwoord. JSON, platte tekst en Markdown-formaten.

Async geeft één opdrachtbon terug; batch geeft één per video ID. Controleer de status van elke taak en haal de resultaten ervan op met behulp van de teruggekeerde links.

Async & batch lifecycle

Indiening geeft een ontvangstbewijs terug, geen resultaten. Async creëert één taak; batch geeft een aparte taak terug in queries[] voor elke geaccepteerde vraag. Traceer en haal elke taak zelfstandig op.

Verzenden naar data.flashdata.dev; lees jobstatus en resultaten van api.flashdata.dev met dezelfde X-API-Key. De gekoppelde API basisvoorbeelden gebruiken Python en cURL.

  1. 1. De taak IDs opslaan

    De verzoekenvelden van deze bron behouden bij het overschakelen naar Async. Zet voor Batch elk verzoek in de query array van een JSON object. Bewaar elke teruggekeerde baan ID.

    Async verzoek en ontvangst · Batch-verzoeklichaam

  2. 2. Status controleren

    GET https://api.flashdata.dev/v2/jobs/{jobId}

    pending / processing: peiling met vertraging en respect Retry-After wanneer aanwezig. completed: resultaten halen. failed: inspectie job.error.

    Lees job.status, niet de status van het inzendingsbewijs.

    Controleer status · Python en cURL

    Job status API referentie
  3. 3. Resultaten ophalen

    GET https://api.flashdata.dev/v2/jobs/{jobId}/results

    Na voltooiing, authenticeer het resultaat gelezen, dan halen de 302 opslag URL zonder uw API sleutel. Bewaar de JSON binnen 24 uren na voltooiing.

    Resultaten · Python en cURL ophalen · Antwoordformaten

    Resultaat download API referentie

Bestudering en het ophalen van bestaande resultaten verbruiken geen query credits. Een polling timeout annuleert de taak niet: houd de ID in plaats van het indienen van dubbele factureerbare werk. Foutcodes en opnieuw proberen gedrag.

Webhooks bij voltooiing

Abonneren per query

Instellen callback_url op het hoogste niveau van een async-verzoek, of binnen elke query in een partij, buiten params. Er is geen afzonderlijk verzoek om webhook-registratie vereist. Realtime-verzoeken sturen geen terugbellers.

Gebruik een publieke HTTPS URL op poort 443. FlashData POST een melding voor elke taak bereiken completed of failed; het evenement bevat links, niet het resultaat zelf.

Bevestigen en verifiëren

Terugkeer 2xx na het duurzaam accepteren van de gebeurtenis. Dedupliceren door delivery_id, ook verzonden als X-Delivery-Id. Redirects worden niet gevolgd.

Mislukte leveringen opnieuw proberen met exponentiële backoff, tot 8 probeert totaal en maximaal 24 uren na voltooiing. Blijf peilen als een terugval.

De terugbellen zijn niet ondertekend. Bevestig de taak ID, bron- en terminalstatus via de geauthentiseerd status-eindpunt vóór de verwerking van de kennisgeving. De levering ID is voor deduplicatie, geen bewijs van authenticiteit.

Voorbeeld webhook event en velden
Kennisgeving van een indicatieve voltooiing
{
  "delivery_id": "completion:job_example0001",
  "id": "job_example0001",
  "source": "youtube_trainability",
  "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"
    }
  ]
}
VeldOmschrijving
delivery_idstringStabiele leveringsidentificatiecode. Notificatieberichten dedupliceren met deze waarde; het wordt ook verzonden in de X-Delivery-Id header.
idstringJob ID.
sourcestringGevraagde databron.
statusstringvoltooid of mislukt.
linksarrayStatus en resultaat links. Meldingen bevatten geen resultaatinhoud of een API-sleutel.
links[].relstringzelf of resultaten.
links[].hrefstringAbsolute Management API URL; authenticeer met je API sleutel.
links[].methodstringGET.

Volledige webhook contract en URL beperkingen

Bulk-bestandsverwerking

Upload één video ID per regel en maak de Bulk job met bron: youtube_trainability. Gedeelde opties zijn van toepassing op elke ID in het bestand.

Deze broncode heeft geen bron-specifieke opties; stel de broncode in en upload het ID bestand.

Haal de voltooide collectie op als een manifeste en gzip-gecomprimeerde NDJSON resultaatdelen. Databronnen kunnen ook resultaatonderdelen leveren aan uw cloudopslag door options.result_storage in te stellen bij het aanmaken van de Bulk-taak. Bewaar het manifest en onderdelen binnen 24 uren nadat de volledige Bulk-taak is voltooid.

Bulk verwerking API · Python en cURL · Batch JSON verzoeken

Bouw een Bulk workflow voor deze bron · Pauze, hervatten en herstellen

Foutherstel

Een ["none"] resultaat is een voltooide licentiecontrole, geen mislukte taak. Het kan betekenen dat het licentielabel afwezig was. Verwijderde of ontoegankelijke video's kunnen falen tijdens extractie.

Gebruik de gedeelde foutreferentie voor authenticatie, saldo, verzoek-formaat en snelheidslimietfouten. Een inzending timeout kan nog steeds een baan hebben gecreëerd; controleer bestaand werk voordat opnieuw te proberen.

Fouten en statuscodes · Wanneer opnieuw proberen · Maximumtarieven

Stapsgewijze handleiding: Licentielabels interpreteren

Prijzen

PlannenGebruikspercentagesper 1.000 standaardaanvragenAbonnementenInclusief credits per facturatieperiode
Betalen naar gebruikUS$ 0,50Geen maandelijkse kostenOpwaarderen wanneer nodig
MicroUS$ 0,40US$ 49,00 / maand1.000 credits (US$ 50,00 of API usance) inclusief
StarterUS$ 0,35US$ 199,00 / maand4.000 credits (US$ 200,00 of API usance) inclusief
ProUS$ 0,30US$ 499,00 / maand10.000 credits (US$ 500,00 of API usance) inclusief
ScaleUS$ 0,25US$ 999,00 / maand20.000 credits (US$ 1.000,00 of API usance) inclusief
BusinessUS$ 0,20US$ 1.999,00 / maand40.000 credits (US$ 2.000,00 of API usance) inclusief

Eén accountabonnement. Gedeelde credits voor alle drie de producten. Gebruik dat door inbegrepen credits wordt gedekt, wordt niet opnieuw in rekening gebracht.

Lopende prijzen en maxima van het plan