Referencia de api rest de Video Search

Punto final:POST https://api.microsoft.ai/v3/search/videos

Solicitud de ejemplo:

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

Parámetro	Required	Tipo	Default	Description
consulta	Sí	string	-	Cadena de consulta de búsqueda. La longitud máxima es de 1000 caracteres.
maxResults	No	integer	30	Número máximo de resultados que se van a devolver. El valor predeterminado es 30 y el valor máximo es 30.
idioma	No	string	"en"	Código de idioma ISO 639-1 de 2 letras para el idioma de la interfaz en los resultados de la búsqueda. Consulte Idiomas admitidos para obtener la lista completa.
region	No	string	"US"	Código de país o región de 2 letras para el que deben proceder los resultados (por ejemplo, "US", "JP", "GB", etc.). Consulte Regiones admitidas para obtener la lista completa.
enablePlaylist	No	booleano	falso	Si se debe incluir la lista de reproducción, se produce una respuesta.
freshness	No	string	-	Intervalo de tiempo para filtrar los resultados en función de la fecha de detección. Admite el formato de intervalo de fecha "week", "month", "year" para el tiempo relativo o el formato de intervalo de fecha ISO 8601: "AAAA-MM-DD/AAAA-MM-DD" o "AAAA-MM-DDTHH:mm:ssZ/AAAA-MM-DDTHH:mm:ssZ" para un intervalo de fecha y hora, use .. para omitir la fecha de inicio o finalización.
incrustable	No	matriz de cadenas	-	Filtre vídeos mediante funcionalidades de inserción. Valores permitidos: "player" (tiene reproductor insertable). Cuando no se establece, no se aplica ningún filtrado.
resolución	No	string	-	Filtre vídeos por resolución mínima . Valores: "360p", "480p", "720p", "1080p". Cuando no se establece, no se aplica ningún filtrado.
safeSearch	No	string	"strict"	Nivel de filtrado de búsqueda segura. Valores: "off", "strict". El valor predeterminado es "strict".
duración	No	string	-	Filtrar vídeos por intervalo de duración. Valores: "short" (<5 min), "medium" (5–20 min), "long" (>20 min). Cuando no se establece, no se aplica ningún filtrado.

Encabezados de solicitud

Field	Tipo	Description
host	string	Host para las API de IA de Microsoft: api.microsoft.ai.
x-apikey o Authorization	string	La clave de API o Entra ID token de acceso para la autenticación.
content-type (tipo de contenido)	string	Tipo MIME del cuerpo de la solicitud. Utilice application/json.

Respuesta

Respuesta de vídeos

Field	Tipo	Description
videoResults	matriz de videoResult	Lista de resultados de vídeo.
listas de reproducción	matriz de playlistResult (opcional)	Lista de resultados de listas de reproducción.
instrumentationClickBase	string	Dirección URL base para hacer clic en solicitudes de ping. Anexe un instrumentationSuffix valor de un elemento de resultado para formar la dirección URL de ping completa. Solo está presente para las aplicaciones con la marca de perfil EnableInstrumentationPing. Nota: Los clics de usuario también se pueden registrar mediante el redireccionamiento de direcciones URL. Cuando la redirección está habilitada, no se requiere ninguna acción para registrar los clics del usuario y instrumentationClickBase no se incluirá en la respuesta. Consulte la guía de instrumentación para obtener instrucciones de configuración.
instrumentationCitationBase	string	Dirección URL base para las solicitudes de ping de registro de LLM. Anexe una carga DE DATOS para formar la dirección URL de ping completa. Solo está presente para las aplicaciones con la marca de perfil EnableInstrumentationPing.
traceId	string	Identificador de seguimiento para la depuración.

Note

playlists es un campo opcional incluso cuando enablePlaylist se establece en true.

videoResult

Field	Tipo	Description
title	string	Título o nombre del vídeo.
url	string	Dirección URL de origen del vídeo. Para los usuarios de China con redirección de direcciones URL habilitadas, este campo contiene la misma dirección URL de redireccionamiento que clickUrl.
domain	string	Host de destino para el resultado. Solo se devuelve para los usuarios de China con el redireccionamiento de direcciones URL habilitado.
description	string	Descripción del contenido del vídeo. Esto lo proporciona el cargador de vídeo o lo genera un LLM.
publishedBy	string	Cargador o publicador del vídeo.
viewCount	long	Número de vistas que tiene el vídeo.
summary	string	Resumen de vídeo generado por IA.
length	string	Longitud del vídeo en formato HH:MM:SS.
allowHttpsEmbedding	booleano	Indica si se permite la inserción https.
allowMobileEmbedding	booleano	Indica si se permite la inserción móvil.
embeddingUrl	string	Dirección URL para insertar el vídeo.
lastUpdatedAt	string	La última fecha actualizada como una cadena con formato.
bestMomentIndex	integer	Índice del mejor momento o resaltado en el vídeo.
Momentos	matriz de momentos	Matriz de segmentos y momentos de vídeo.
URL de miniatura	string	Dirección URL de miniatura del vídeo.
width	integer	Ancho del vídeo en píxeles.
height	integer	Alto del vídeo en píxeles.
isAdult	booleano	Indica si el resultado incluye contenido para adultos.
clickUrl	string	Url de redirección que proxie el clic a través de Bing. Solo está presente cuando el redireccionamiento de clics está habilitado.
instrumentationSuffix	string	Sufijo que se va a anexar a la base de dirección URL de ping de instrumentación para este elemento de resultado. Se usa como valor K para la dirección URL de ping de instrumentación y el clickUrl redireccionamiento. Presente cuando el ping de instrumentación está habilitado.

Note

Varios de los campos anteriores son opcionales: se sirven si están disponibles.

moment

Field	Tipo	Description
title	string	Título del segmento de momento.
description	string	Descripción de lo que sucede en este momento.
startTime	string	Hora de inicio del momento con el formato "d.hh:mm:ss".
endTime	string	Hora de finalización del momento en formato 'd.hh:mm:ss'.
momentUrl	string	Dirección URL directa a este momento específico en el vídeo.

Note

moment es un objeto de respuesta opcional. No está disponible para cada resultado de vídeo.

playlistResult

Field	Tipo	Description
title	string	Título de la lista de reproducción.
description	string	Descripción de la lista de reproducción.
Vídeos	matriz de vídeo	Matriz de vídeos en la lista de reproducción.

Note

playlistResult es un objeto de respuesta opcional.

video

Field	Tipo	Description
title	string	Título del vídeo.
description	string	Descripción del vídeo.
url	string	URL del vídeo.

Códigos de error

Código de estado	Categoría de error	Description	Causas comunes
200	Success	La solicitud tuvo éxito.	-
400	Solicitud incorrecta	Parámetros de solicitud no válidos.	Faltan campos obligatorios, valores de parámetro no válidos, JSON con formato incorrecto
401	Unauthorized	Error de autenticación o falta.	Clave de API no válida, falta el encabezado x-apikey
403	Prohibida	Credenciales válidas pero permisos insuficientes.	La clave de API carece de permisos necesarios
410	Pasado (Gone)	SE requiere HTTPS.	Solicitud realizada a través de HTTP en lugar de HTTPS
415	Tipo de medio no admitido	No se admite el tipo de contenido.	Falta o falta un encabezado de tipo de contenido incorrecto
429	Demasiadas solicitudes	Se superó el límite de velocidad.	Demasiadas solicitudes en el período de tiempo
500	Error interno del servidor	Error inesperado del servidor.	Problema de servidor temporal
503	Servicio no disponible	El servicio no está disponible temporalmente.	Interrupción temporal o mantenimiento
504	Tiempo de espera de puerta de enlace	Se ha agotado el tiempo de espera para la solicitud.	Tiempo de espera del servicio ascendente

Para obtener instrucciones detalladas sobre el control de errores, consulte Control de errores.

---

Consulte también:Web Search Browse | | News Search | Images Search | MCP