Rest-API-Referenz für die Videosuche

Endpunkt:POST https://api.microsoft.ai/v3/search/videos

Beispielanforderung:

curl -X POST "https://api.microsoft.ai/v3/search/videos" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "cute puppy videos",
    "maxResults": 30,
    "language": "en",
    "region": "US"
  }'

Parameters

Parameter Required Typ Vorgabe Description
query Yes string - Eine Suchabfragezeichenfolge. Die maximale Länge beträgt 1000 Zeichen.
maxResults No integer 30 Maximale Anzahl der zurückzugebenden Ergebnisse. Der Standardwert ist 30, und der Maximalwert ist 30.
language No string „de“ Ein 2-Buchstaben-ISO 639-1-Sprachcode für die Schnittstellensprache in den Suchergebnissen. Die vollständige Liste finden Sie unter "Unterstützte Sprachen ".
region No string "US" Ein 2-Buchstaben-Länder-/Regionscode für den Ort, aus dem die Ergebnisse stammen sollen (z. B. "US", "JP", "GB" usw.). Die vollständige Liste finden Sie unter "Unterstützte Regionen ".
enablePlaylist No boolean Falsch Gibt an, ob Wiedergabelistenergebnisse als Antwort einbezogen werden sollen.
freshness No string - Der Zeitraum zum Filtern von Ergebnissen basierend auf dem Ermittlungsdatum. Unterstützt das Datumsintervallformat "Woche", "Monat", "Jahr" für relative Zeit oder ISO 8601-Datumsintervallformat: "JJJJ-MM-TT/JJJJ-MM-DD" oder "JJJJ-MM-DDTHH:mm:ssZ/YYYYY-MM-DDTHH:mm:ssZ" für einen Datums-/Datumstimebereich. aus, um das Start- oder Enddatum auszulassen.
Einbettbar No Array von Strings - Filtern Sie Videos durch Einbettungsfunktionen. Zulässige Werte: "Player" (hat einbettbare Spieler). Wenn sie nicht festgelegt ist, wird keine Filterung angewendet.
Auflösung No string - Filtern sie Videos nach minimaler Auflösung. Werte: "360p", "480p", "720p", "1080p". Wenn sie nicht festgelegt ist, wird keine Filterung angewendet.
safeSearch No string "streng" Ebene der sicheren Suchfilterung. Werte: "off", "strict". Der Standardwert ist "strict".
Dauer No string - Filtern sie Videos nach Dauerbereich. Werte: "short" (<5 min), "mittel" (5–20 min), "long" (>20 min). Wenn sie nicht festgelegt ist, wird keine Filterung angewendet.

Anforderungsheader

Feld Typ Description
host string Host für Microsoft AI-APIs: api.microsoft.ai.
x-apikey oder Autorisierung string Ihr API-Schlüssel oder Entra ID Zugriffstoken für die Authentifizierung.
Inhaltstyp string MIME-Typ des Anforderungstexts. Verwenden Sie application/json.

Antwort

Videoantwort

Feld Typ Description
videoResults Array von videoResult Liste der Videoergebnisse.
Wiedergabelisten Array von playlistResult (optional) Liste der Wiedergabelistenergebnisse.
instrumentationClickBase string Basis-URL zum Klicken auf Pinganforderungen. Fügen Sie einen instrumentationSuffix Wert aus einem Ergebniselement an, um die vollständige Ping-URL zu bilden. Nur für Anwendungen mit dem EnableInstrumentationPing-Profilflagge vorhanden. Hinweis: Benutzerklicks können auch mithilfe der URL-Umleitung protokolliert werden. Wenn die Umleitung aktiviert ist, ist keine Aktion erforderlich, um Benutzerklicks zu protokollieren und instrumentationClickBase nicht in die Antwort eingeschlossen. Anweisungen zum Einrichten finden Sie im Handbuch zur Instrumentierung .
instrumentationCitationBase string Basis-URL für LLM-Protokollpinganforderungen. Fügen Sie eine DATA-Nutzlast an, um die vollständige Ping-URL zu bilden. Nur für Anwendungen mit dem EnableInstrumentationPing-Profilflagge vorhanden.
traceId string Ablaufverfolgungs-ID für das Debuggen.

Note

playlists ist ein optionales Feld, auch wenn enablePlaylist er auf "true" festgelegt ist.

videoResult

Feld Typ Description
title string Der Titel oder Name des Videos.
url string Die Quell-URL des Videos. Für China-Benutzer mit aktivierter URL-Umleitung enthält dieses Feld stattdessen dieselbe Umleitungs-URL wie clickUrl.
domain string Der Zielhost für das Ergebnis. Wird nur für China-Benutzer mit aktivierter URL-Umleitung zurückgegeben.
description string Beschreibung des Videoinhalts. Dies wird entweder vom Videouploader bereitgestellt oder von einem LLM generiert.
publishedBy string Uploader oder Herausgeber des Videos.
viewCount long Die Anzahl der Ansichten, über die das Video verfügt.
summary string KI-generierte Videozusammenfassung.
length string Die Länge des Videos im HH:MM:SS-Format.
allowHttpsEmbedding boolean Gibt an, ob HTTPS-Einbettung zulässig ist.
allowMobileEmbedding boolean Gibt an, ob mobile Einbettungen zulässig sind.
embeddingUrl string URL zum Einbetten des Videos.
lastUpdatedAt string Das datum der letzten Aktualisierung als formatierte Zeichenfolge.
bestMomentIndex integer Index des besten Moments oder Hervorhebens im Video.
Augenblicke Matrix des Moments Array von Videosegmenten/Momenten.
thumbnailUrl string Miniaturansichts-URL des Videos.
width integer Die Breite des Videos in Pixeln.
height integer Die Höhe des Videos in Pixeln.
isAdult boolean Gibt an, ob das Ergebnis erwachsene Inhalte enthält.
clickUrl string Umleitungs-URL, die den Klick durch Bing proxiest. Nur vorhanden, wenn die Klickumleitung aktiviert ist.
instrumentationSuffix string Suffix, das an die URL-Basis der Instrumentierung für dieses Ergebniselement angefügt werden soll. Wird als K-Wert sowohl für die Ping-URL der Instrumentation als auch für die clickUrl Umleitung verwendet. Vorhanden, wenn die Instrumentierungs-Ping aktiviert ist.

Note

Einige der oben genannten Felder sind optional – sie werden bereitgestellt, wenn sie verfügbar sind.

Moment

Feld Typ Description
title string Titel des Momentsegments.
description string Beschreibung, was in diesem Moment passiert.
startTime string Startzeit des Augenblicks im Format 'd.hh:mm:ss'.
endTime string Endzeit des Augenblicks im Format 'd.hh:mm:ss'.
momentUrl string Direkte URL zu diesem bestimmten Moment im Video.

Note

moment ist ein optionales Antwortobjekt. Es ist nicht für jedes Videoergebnis verfügbar.

playlistResult

Feld Typ Description
title string Titel der Wiedergabeliste.
description string Beschreibung der Wiedergabeliste.
Videos Array von Video Array von Videos in der Wiedergabeliste.

Note

playlistResult ist ein optionales Antwortobjekt.

video

Feld Typ Description
title string Titel des Videos.
description string Beschreibung des Videos.
url string URL des Videos.

Fehlercodes

Statuscode Fehlerkategorie Description Häufige Ursachen
200 Success Die Anfrage war erfolgreich. -
400 Ungültige Anforderung Ungültige Anforderungsparameter. Fehlende erforderliche Felder, ungültige Parameterwerte, falsch formatierter JSON-Code
401 Unauthorized Fehler bei der Authentifizierung oder fehlender Authentifizierung. Ungültiger API-Schlüssel, fehlender x-apikey-Header
403 Verboten Gültige Anmeldeinformationen, aber unzureichende Berechtigungen. API-Schlüssel verfügt nicht über erforderliche Berechtigungen
410 Nicht vorhanden (Gone) HTTPS erforderlich. Anforderung über HTTP anstelle von HTTPS
415 Nicht unterstützter Medientyp Der Inhaltstyp wird nicht unterstützt. Fehlender oder falscher Inhaltstypheader
429 Zu viele Anforderungen Das Ratenlimit wurde überschritten. Zu viele Anforderungen im Zeitfenster
500 Interner Serverfehler Unerwarteter Serverfehler. Temporäres Serverproblem
503 Dienst nicht verfügbar Der Dienst ist vorübergehend nicht verfügbar. Wartung oder vorübergehender Ausfall
504 Gateway-Zeitüberschreitung Zeitüberschreitung bei der Anforderung. Timeout des Upstream-Diensts

Ausführliche Anleitungen zur Fehlerbehandlung finden Sie unter "Fehlerbehandlung".

Siehe auch:Web search | Browse | News Search | Images Search | MCP

  • Zuletzt aktualisiert um