Procurar referência da API REST

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

Solicitação de exemplo:

curl -X POST "https://api.microsoft.ai/v3/browse" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H "content-type: application/json" \
  -d '{
    "url": "https://news.microsoft.com/source/",
    "maxLength": 3000,
    "language": "en",
    "region": "US",
    "contentFormat": "html"
  }'

Parameters

Parâmetro Required Tipo Default Description
url Yes cadeia - A URL da página da Web a ser navegada.
comprimento máximo No inteiro 10000 O número máximo de caracteres no campo de conteúdo em resposta. O valor máximo é de 500000 caracteres.
liveCrawl No cadeia "nenhum" Controla o comportamento de rastreamento dinâmico. Valores: "none" (retornar somente conteúdo indexado), "fallback" (rastreamento se a URL não for encontrada no índice), "force" (solicite um novo rastreamento mesmo se houver conteúdo indexado). Observe que, para o valor "nenhum", se a URL não for encontrada no índice, a API retornará o código de erro 404 (URL não encontrada).
includeWebLinks No boolean falso Inclua hiperlinks de saída da página.
renderDynamicPages No boolean falso Habilite a renderização do JavaScript para captura de tela de conteúdo dinâmico. Só funciona quando liveCrawl é definido como "fallback".
includeImageLinks No boolean falso Inclua URLs de imagem da página.
linguagem No cadeia "en" O código de idioma (ISO 639-1 de 2 letras). Consulte idiomas com suporte para a lista completa.
região No cadeia "US" O código da região (código de país/região de 2 letras). Consulte regiões com suporte para obter a lista completa.
formato de conteúdo No cadeia "html" O formato do conteúdo da página da Web a ser retornado. Pode ser "text", "html" ou "markdown".

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

Field Tipo Description
url cadeia A URL da página da Web.
title cadeia O título da página da Web.
conteúdo cadeia O conteúdo extraído da página da Web (também conhecido como aterramento).
lastUpdatedAt cadeia A última data atualizada da página da Web segue ISO8601 formato.
crawledAt cadeia A última data rastreada da página da Web segue ISO8601 formato.
liveCrawlSucceeded booliano (opcional) Presente apenas como false quando uma solicitação bem-sucedida com liveCrawl: "force" retorna uma página obsoleta. Omitido para páginas não obsoletas; nunca emitido como true. Omitido para "none""fallback", um modo omitido/nulo e respostas de repetição (202).
traceId cadeia ID de rastreamento para depuração.
retryAfter cadeia Tempo de espera antes de tentar novamente, formatado como uma duração em segundos com o "s" sufixo (por exemplo, "60s" significa aguardar 60 segundos). Só está presente quando o rastreamento sob demanda está em andamento.
isAdult boolean Indica se a página da Web contém conteúdo adulto.

Note

Os titlecampos, , contentisAdulte lastUpdatedAtcrawledAt , só estão presentes em respostas bem-sucedidas (200). Eles são omitidos de respostas de repetição (202).

Por exemplo, uma solicitação bem-sucedida com "liveCrawl": "force" inclui "liveCrawlSucceeded": false somente quando o conteúdo obsoleto é retornado. Uma página não obsoleta omite esse campo em vez de trueretornar. Esse campo tem o mesmo significado na resposta estruturada da ferramenta Procurar MCP.

Códigos de erro

Código de Status Categoria do Erro Description Causas comuns
200 Êxito O pedido foi bem-sucedido. -
202 Aceitado Solicitação aceita para processamento (rastreamento dinâmico). Rastreamento sob demanda em andamento
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 a solicitação não pode ser atendida. A chave de API não tem permissões necessárias, URL bloqueada por política, conteúdo filtrado
404 Não encontrado Documento não encontrado. URL inválida ou inacessível
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
430 Muitos rastreamentos sob demanda Muitos rastreamentos sob demanda. Solicitações de rastreamento ao vivo excessivas
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 deVídeosde Pesquisa na Web | Pesquisa | | deImagens de | Pesquisade Imagens MCP

  • Última atualização em