Referência da API REST de Pesquisa de Vídeo

Ponto de extremidade:POST https://api.microsoft.ai/v3/search/videos

Solicitação de exemplo:

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	Yes	cadeia	-	Uma cadeia de caracteres de consulta de pesquisa. O comprimento máximo é de 1000 caracteres.
maxResults	No	inteiro	30	Número máximo de resultados a serem retornados. O padrão é 30 e o valor máximo é 30.
linguagem	No	cadeia	"en"	Um código de idioma ISO 639-1 de 2 letras para linguagem de interface nos resultados da pesquisa. Consulte idiomas com suporte para a lista completa.
região	No	cadeia	"US"	Um código de país/região de duas letras de onde os resultados devem vir (por exemplo, "EUA", "JP", "GB", etc.). Consulte regiões com suporte para obter a lista completa.
enablePlaylist	No	boolean	falso	Se incluir os resultados da playlist em resposta.
freshness	No	cadeia	-	O intervalo de tempo para filtrar os resultados com base na data da descoberta. Dá suporte ao formato de intervalo de data "semana", "mês", "ano" para tempo relativo ou ISO 8601: "YYYYY-MM-DD/YYYY-MM-DD" ou "YYYYY-MM-DDTHH:mm:ssZ/YYYY-MM-DDTHH:mm:ssZ" para um intervalo de data/data/data, use .. para omitir a data de início ou de término.
inserível	No	matriz de strings	-	Filtrar vídeos inserindo recursos. Valores permitidos: "player" (tem player inserível). Quando não definido, nenhuma filtragem é aplicada.
resolução	No	cadeia	-	Filtrar vídeos por resolução mínima . Valores: "360p", "480p", "720p", "1080p". Quando não definido, nenhuma filtragem é aplicada.
safeSearch	No	cadeia	"estrito"	Nível de filtragem de pesquisa segura. Valores: "off", "strict". O padrão é "estrito".
duração	No	cadeia	-	Filtrar vídeos por intervalo de duração. Valores: "short" (<5 min), "medium" (5 a 20 min), "long" (>20 min). Quando não definido, nenhuma filtragem é aplicada.

Cabeçalhos da solicitação

Field	Tipo	Description
hospedar	cadeia	Host para APIs de IA Microsoft: api.microsoft.ai.
x-apikey ou Autorização	cadeia	Sua chave de API ou Entra ID token de acesso para autenticação.
tipo de conteúdo	cadeia	Tipo MIME do corpo da solicitação. Use application/json.

Resposta

Resposta de vídeos

Field	Tipo	Description
videoResults	matriz de videoResult	Lista de resultados de vídeo.
playlists	matriz de playlistResult (opcional)	Lista de resultados da playlist.
instrumentationClickBase	cadeia	URL base para clicar em solicitações de ping. Acrescente um instrumentationSuffix valor de um item de resultado para formar a URL de ping completa. Presente apenas para aplicativos com o sinalizador de perfil EnableInstrumentationPing. Observação: os cliques do usuário também podem ser registrados usando o redirecionamento de URL. Quando o redirecionamento estiver habilitado, nenhuma ação será necessária para registrar cliques do usuário e instrumentationClickBase não será incluída na resposta. Consulte o guia de Instrumentação para obter instruções de instalação.
instrumentationCitationBase	cadeia	URL base para solicitações de ping de log llm. Acrescente um conteúdo de DADOS para formar a URL de ping completa. Presente apenas para aplicativos com o sinalizador de perfil EnableInstrumentationPing.
traceId	cadeia	ID de rastreamento para depuração.

Note

playlists é um campo opcional mesmo quando enablePlaylist é definido como true.

videoResult

Field	Tipo	Description
title	cadeia	O título ou o nome do vídeo.
url	cadeia	A URL de origem do vídeo. Para usuários da China com redirecionamento de URL habilitado, esse campo contém a mesma URL de redirecionamento que clickUrl.
domínio	cadeia	O host de destino para o resultado. Retornado somente para usuários da China com redirecionamento de URL habilitado.
description	cadeia	Descrição do conteúdo do vídeo. Isso é fornecido pelo carregador de vídeo ou gerado por uma LLM.
publishedBy	cadeia	Uploader ou editor do vídeo.
viewCount	longo	O número de exibições que o vídeo tem.
resumo	cadeia	Resumo de vídeo gerado por IA.
length	cadeia	O comprimento do vídeo no formato HH:MM:SS.
allowHttpsEmbedding	boolean	Se a inserção HTTPS é permitida.
allowMobileEmbedding	boolean	Se a inserção móvel é permitida.
embeddingUrl	cadeia	URL para inserir o vídeo.
lastUpdatedAt	cadeia	A última data atualizada como uma cadeia de caracteres formatada.
bestMomentIndex	inteiro	Índice do melhor momento ou realce no vídeo.
Momentos	matriz de momento	Matriz de segmentos/momentos de vídeo.
URL da miniatura	cadeia	URL em miniatura do vídeo.
width	inteiro	A largura do vídeo em pixels.
height	inteiro	A altura do vídeo em pixels.
isAdult	boolean	Indica se o resultado inclui conteúdo adulto.
clickUrl	cadeia	URL de redirecionamento que faz o proxie do clique por meio do Bing. Só está presente quando o redirecionamento de clique está habilitado.
instrumentationSuffix	cadeia	Sufixo a ser acrescentado à base de URL de ping de instrumentação para este item de resultado. Usado como o valor K para a URL de ping de instrumentação e o clickUrl redirecionamento. Presente quando o ping de instrumentação estiver habilitado.

Note

Vários dos campos acima são opcionais– eles são atendidos se estiverem disponíveis.

momento

Field	Tipo	Description
title	cadeia	Título do segmento de momento.
description	cadeia	Descrição do que acontece neste momento.
startTime	cadeia	Hora de início do momento no formato 'd.hh:mm:ss'.
endTime	cadeia	Hora de término do momento no formato 'd.hh:mm:ss'.
momentUrl	cadeia	Direcione a URL para esse momento específico no vídeo.

Note

moment é um objeto de resposta opcional. Ele não está disponível para cada resultado de vídeo.

playlistResult

Field	Tipo	Description
title	cadeia	Título da playlist.
description	cadeia	Descrição da playlist.
vídeos	matriz de vídeo	Matriz de vídeos na playlist.

Note

playlistResult é um objeto de resposta opcional.

vídeo

Field	Tipo	Description
title	cadeia	Título do vídeo.
description	cadeia	Descrição do vídeo.
url	cadeia	URL do vídeo.

Códigos de erro

Código de Status	Categoria do Erro	Description	Causas comuns
200	Êxito	O pedido foi bem-sucedido.	-
400	Solicitação incorreta	Parâmetros de solicitação inválidos.	Campos necessários ausentes, valores de parâmetro inválidos, JSON malformado
401	Unauthorized	Falha ou falha na autenticação.	Chave de API inválida, cabeçalho x-apikey ausente
403	Proibido	Credenciais válidas, mas permissões insuficientes.	A chave de API não tem permissões necessárias
410	Sumiu (Gone)	HTTPS necessário.	Solicitação feita por HTTP em vez de HTTPS
415	Tipo de mídia sem suporte	Não há suporte para o tipo de conteúdo.	Cabeçalho de tipo de conteúdo ausente ou incorreto
429	Número Excessivo de Solicitações	Limite de taxa excedido.	Muitas solicitações na janela de tempo
500	Erro interno do servidor	Erro de servidor inesperado.	Problema temporário do servidor
503	Serviço indisponível	Serviço temporariamente indisponível.	Manutenção ou interrupção temporária
504	Tempo de Espera do Gateway (Gateway Timeout)	A solicitação expirou.	Tempo limite do serviço upstream

Para obter diretrizes detalhadas de tratamento de erros, consulte Tratamento de Erros.

---

Consulte também:Pesquisa na Web | Procurar | MCP de Pesquisa de Imagens dePesquisa | de | Notícias