Consultar referência da API REST

Ponto final:POST https://api.microsoft.ai/v3/browse

Pedido 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

Parameter Required Tipo Default Description
url Yes cadeia (de caracteres) - O URL da página web para navegar.
comprimento máximo No número 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 (de caracteres) "nenhum" Controla o comportamento de rastejar ao vivo. Valores: "nenhum" (apenas devolve conteúdo indexado), "fallback" (rastrear se o URL não estiver no índice), "force" (solicitar um novo crawl mesmo que exista conteúdo indexado). Note que para o valor "nenhum", se a URL não for encontrada no índice, a API devolverá o código de erro 404 (URL não encontrada).
incluiWebLinks No boolean falso Inclua hiperligações de saída da página.
renderDynamicPages No boolean falso Ativar a renderização em JavaScript para captura de ecrã de conteúdo dinâmico. Só funciona quando o liveCrawl está definido para "fallback".
incluiImagenLinks No boolean falso Inclua URLs de imagens da página.
linguagem No cadeia (de caracteres) "en" O código da língua (ISO 639-1 de 2 letras). Consulte Linguagens Suportadas para a lista completa.
região No cadeia (de caracteres) "US" O código regional (código país/região de 2 letras). Consulte Regiões Suportadas para a lista completa.
contentFormat No cadeia (de caracteres) "html" O formato do conteúdo da página web deve regressar. Pode ser "text", "html" ou "markdown".

Cabeçalhos dos Pedidos

Field Tipo Description
alojar cadeia (de caracteres) Alojamento para APIs de IA da Microsoft: api.microsoft.ai.
x-apikey ou Autorização cadeia (de caracteres) A sua chave API ou token de acesso do Entra ID para autenticação.
tipo de conteúdo cadeia (de caracteres) Tipo MIME do corpo do pedido. Utilize application/json.

Resposta

Field Tipo Description
url cadeia (de caracteres) O URL da página Web.
title cadeia (de caracteres) O título da página web.
conteúdo cadeia (de caracteres) O conteúdo extraído da página web (também conhecido como grounding).
lastUpdatedAt cadeia (de caracteres) A data de última atualização da página segue ISO8601 formato.
rastejou cadeia (de caracteres) A última data rastreada da página web segue ISO8601 formato.
liveCrawlSucceeded Booleano (opcional) Só aparece quando false um pedido bem-sucedido devolve liveCrawl: "force" uma página obsoleta. Omitido para páginas não obsoletas; nunca emitido como true. Omitido para "none", "fallback", um modo omitido/nulo, e retentar (202) respostas.
traceId cadeia (de caracteres) ID de rastreio para depuração.
retryAfter cadeia (de caracteres) Tempo para esperar antes de tentar novamente, formatado como uma duração em segundos com o "s" sufixo (por exemplo, "60s" significa esperar 60 segundos). Só está presente quando o crawl on-demand está em curso.
éAdulto boolean Indica se a página contém conteúdo para adultos.

Note

Os titlecampos , content, isAdult, lastUpdatedAt, e crawledAt só estão presentes em respostas bem-sucedidas (200). São omitidas nas respostas de retry (202).

Por exemplo, um pedido bem-sucedido inclui "liveCrawl": "force""liveCrawlSucceeded": false apenas quando conteúdo obsoleto é devolvido. Uma página não obsoleta omite este campo em vez de devolver true. Este campo tem o mesmo significado na resposta estruturada da ferramenta Browse MCP.

Códigos de erro

Código de estado Categoria de Erro Description Causas Comuns
200 Sucesso O pedido foi bem-sucedido. -
202 Aceito Pedido aceite para processamento (live crawl). Rastreamento on-demand em curso
400 Pedido Incorreto Parâmetros de pedido inválidos. Campos obrigatórios em falta, valores de parâmetros inválidos, JSON mal formado
401 Não autorizado Autenticação falhada ou em falta. Chave API inválida, falta do cabeçalho x-apikey
403 Proibido Credenciais válidas, mas o pedido não pode ser cumprido. A chave API não tem permissões obrigatórias, URL bloqueada pela política, conteúdo filtrado
404 Não encontrado Documento não encontrado. URL inválida ou inacessível
410 Desapareceu HTTPS necessário. Pedido feito por HTTP em vez de HTTPS
415 Tipo de Media Não Suportado Tipo de conteúdo não suportado. Cabeçalho de tipo de conteúdo em falta ou incorreto
429 Demasiados Pedidos Limite de taxa ultrapassado. Demasiados pedidos numa janela temporal
430 Demasiadas Explorações On-Demand Demasiados crawls a pedido. Pedidos excessivos de rastreamento ao vivo
500 Erro interno do servidor Erro inesperado do servidor. Problema temporário com o servidor
503 Serviço Indisponível Serviço temporariamente indisponível. Manutenção ou interrupção temporária
504 Tempo limite do gateway O tempo limite da solicitação expirou. Tempo de extinção do serviço a montante

Para orientações detalhadas sobre o tratamento de erros, consulte Gestão de Erros.

Ver também:Pesquisa | na Web Vídeos Pesquisa | Notícias Pesquisa | Imagens Pesquisa MCP |

  • Última atualização a