Informations de référence sur l’API REST De recherche de vidéos

Point de terminaison :POST https://api.microsoft.ai/v3/search/videos

Exemple de demande :

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

Paramètre	Required	Type	Default	Description
query	Yes	string	-	Chaîne de requête de recherche. La longueur maximale est de 1 000 caractères.
maxResults	Non	integer	30	Nombre maximal de résultats à retourner. La valeur par défaut est 30 et la valeur maximale est 30.
langue	Non	string	« en »	Code de langue ISO 639-1 de 2 lettres pour la langue de l’interface dans les résultats de recherche. Consultez les langues prises en charge pour obtenir la liste complète.
region	Non	string	"US"	Code pays/région de 2 lettres pour lequel les résultats doivent provenir (par exemple, « US », « JP », « GB », etc.). Consultez les régions prises en charge pour obtenir la liste complète.
enablePlaylist	Non	boolean	faux	Indique s’il faut inclure des résultats de playlist en réponse.
freshness	Non	string	-	Intervalle de temps pour filtrer les résultats en fonction de la date de découverte. Prend en charge « week », « month », « year » pour l’heure relative ou le format d’intervalle de date ISO 8601 : « AAAA-MM-DD/AAAA-MM-DD » ou « AAAA-MM-DDTHH :mm :ssZ/AAAA-MM-DDTHH :mm :mm :ssZ » pour une plage date/datetime, utilisez .. pour omettre la date de début ou de fin.
incorporable	Non	tableau de chaînes	-	Filtrez les vidéos en intégrant des fonctionnalités. Valeurs autorisées : « player » (a un lecteur pouvant être incorporé). Lorsqu’il n’est pas défini, aucun filtrage n’est appliqué.
resolution	Non	string	-	Filtrez les vidéos par résolution minimale . Valeurs : « 360p », « 480p », « 720p », « 1080p ». Lorsqu’il n’est pas défini, aucun filtrage n’est appliqué.
safeSearch	Non	string	« strict »	Niveau de filtrage de recherche sécurisé. Valeurs : « off », « strict ». La valeur par défaut est « strict ».
durée	Non	string	-	Filtrez les vidéos par plage de durée. Valeurs : « short » (<5 min), « medium » (5 à 20 min), « long » (>20 min). Lorsqu’il n’est pas défini, aucun filtrage n’est appliqué.

En-têtes de requête

Champ	Type	Description
host	string	Hôte pour Microsoft API IA : api.microsoft.ai.
x-apikey ou autorisation	string	Votre clé API ou votre jeton d’accès Entra ID pour l’authentification.
type de contenu	string	Type MIME du corps de la requête. Utilisez application/json.

Response

Réponse aux vidéos

Champ	Type	Description
videoResults	tableau de videoResult	Liste des résultats vidéo.
playlists	tableau de playlistResult (facultatif)	Liste des résultats de la playlist.
instrumentationClickBase	string	URL de base pour cliquer sur les requêtes ping. Ajoutez une instrumentationSuffix valeur à partir d’un élément de résultat pour former l’URL ping complète. Présente uniquement pour les applications avec l’indicateur de profil EnableInstrumentationPing. Remarque : les clics utilisateur peuvent également être enregistrés à l’aide de la redirection d’URL. Lorsque la redirection est activée, aucune action n’est nécessaire pour journaliser les clics utilisateur et instrumentationClickBase ne sera pas incluse dans la réponse. Consultez le guide d’instrumentation pour obtenir des instructions de configuration.
instrumentationCitationBase	string	URL de base pour les requêtes ping du journal LLM. Ajoutez une charge utile DATA pour former l’URL ping complète. Présente uniquement pour les applications avec l’indicateur de profil EnableInstrumentationPing.
traceId	string	ID de trace pour le débogage.

Note

playlists est un champ facultatif, même lorsqu’il enablePlaylist est défini sur true.

videoResult

Champ	Type	Description
title	string	Titre ou nom de la vidéo.
url	string	URL source de la vidéo. Pour les utilisateurs chinois avec la redirection d’URL activée, ce champ contient plutôt la même URL de redirection que clickUrl.
domain	string	Hôte de destination pour le résultat. Retourné uniquement pour les utilisateurs chinois avec redirection d’URL activée.
description	string	Description du contenu vidéo. Cela est fourni par le chargeur vidéo ou généré par un LLM.
publishedBy	string	Chargeur ou éditeur de la vidéo.
viewCount	long	Nombre de vues de la vidéo.
summary	string	Résumé vidéo généré par l’IA.
length	string	Longueur de la vidéo au format HH :MM :SS.
allowHttpsEmbedding	boolean	Indique si l’incorporation HTTPS est autorisée.
allowMobileEmbedding	boolean	Indique si l’incorporation mobile est autorisée.
embeddingUrl	string	URL de l’incorporation de la vidéo.
lastUpdatedAt	string	Date de dernière mise à jour sous forme de chaîne mise en forme.
bestMomentIndex	integer	Index du meilleur moment ou mise en surbrillance dans la vidéo.
Moments	tableau de moments	Tableau de segments/moments vidéo.
URL de la vignette	string	URL miniature de la vidéo.
width	integer	Largeur de la vidéo en pixels.
height	integer	Hauteur de la vidéo en pixels.
isAdult	boolean	Indique si le résultat inclut du contenu pour adultes.
clickUrl	string	URL de redirection qui proxie le clic via Bing. Présente uniquement lorsque la redirection en un clic est activée.
instrumentationSuffix	string	Suffixe à ajouter à la base d’URL ping d’instrumentation pour cet élément de résultat. Utilisé comme valeur K pour l’URL ping d’instrumentation et la clickUrl redirection. Présent lorsque le test ping d’instrumentation est activé.

Note

Plusieurs des champs ci-dessus sont facultatifs : ils sont servis s’ils sont disponibles.

moment

Champ	Type	Description
title	string	Titre du segment moment.
description	string	Description de ce qui se passe dans ce moment.
startTime	string	Heure de début du moment au format 'd.hh :mm :ss'.
endTime	string	Heure de fin du moment au format 'd.hh :mm :ss'.
momentUrl	string	URL directe vers ce moment spécifique dans la vidéo.

Note

moment est un objet de réponse facultatif. Il n’est pas disponible pour chaque résultat vidéo.

playlistResult

Champ	Type	Description
title	string	Titre de la playlist.
description	string	Description de la playlist.
vidéos	tableau de vidéos	Tableau de vidéos dans la playlist.

Note

playlistResult est un objet de réponse facultatif.

vidéo

Champ	Type	Description
title	string	Titre de la vidéo.
description	string	Description de la vidéo.
url	string	URL de la vidéo.

Codes d’erreur

Code de statut	Catégorie d’erreur	Description	Causes courantes
200	Success	La demande a abouti.	-
400	Demande incorrecte	Paramètres de requête non valides.	Champs obligatoires manquants, valeurs de paramètre non valides, JSON mal formé
401	Unauthorized	Échec ou absence de l’authentification.	Clé API non valide, en-tête x-apikey manquant
403	Interdit	Informations d’identification valides, mais autorisations insuffisantes.	La clé API ne dispose pas des autorisations requises
410	Non disponible (Gone)	HTTPS requis.	Requête effectuée sur HTTP au lieu de HTTPS
415	Type de média non pris en charge	Type de contenu non pris en charge.	En-tête de type de contenu manquant ou incorrect
429	Trop de demandes	Limite de débit dépassée.	Trop de requêtes dans la fenêtre de temps
500	Erreur interne du serveur	Erreur de serveur inattendue.	Problème de serveur temporaire
503	Service indisponible	Service temporairement indisponible.	Pannes de maintenance ou temporaires
504	Délai d’expiration de la passerelle	La requête a expiré.	Délai d’expiration du service en amont

Pour obtenir des instructions détaillées sur la gestion des erreurs, consultez Gestion des erreurs.

---

Voir aussi :Recherche webParcourir les | imagesde recherche | d’actualités Recherche | | d’imagesMCP