Parcourir les informations de référence sur l’API REST

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

Exemple de demande :

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

Paramètre Required Type Default Description
url Yes string - URL de la page web à parcourir.
longueur maximale Non integer 10000 Nombre maximal de caractères dans le champ de contenu en réponse. La valeur maximale est de 5 0000 caractères.
liveCrawl Non string « aucun » Contrôle le comportement d’analyse dynamique. Valeurs : « aucun » (seul retour du contenu indexé), « secours » (analyse si l’URL n’est pas trouvée dans l’index), « force » (demander une nouvelle analyse même si le contenu indexé existe). Notez que pour la valeur « none », si l’URL est introuvable dans l’index, l’API retourne le code d’erreur 404 (URL introuvable).
includeWebLinks Non boolean faux Inclure des liens hypertexte sortants à partir de la page.
renderDynamicPages Non boolean faux Activer le rendu JavaScript pour la capture d’écran du contenu dynamique. Fonctionne uniquement lorsque liveCrawl est défini sur « secours ».
includeImageLinks Non boolean faux Incluez des URL d’image à partir de la page.
langue Non string « en » Code de langue (2 lettres ISO 639-1). Consultez les langues prises en charge pour obtenir la liste complète.
region Non string "US" Code régional (code pays/région à 2 lettres). Consultez les régions prises en charge pour obtenir la liste complète.
contentFormat Non string « html » Format du contenu de la page web à retourner. Peut être « text », « html » ou « markdown ».

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

Champ Type Description
url string URL de la page web.
title string Titre de la page Web.
contenu string Contenu extrait de la page web (aka grounding).
lastUpdatedAt string La dernière date de mise à jour de la page web suit ISO8601 format.
crawledAt string La dernière date analysée de la page web suit ISO8601 format.
liveCrawlSucceededed booléen (facultatif) Présente uniquement comme false lorsqu’une requête réussie avec liveCrawl: "force" retourne une page obsolète. Omis pour les pages non obsolètes ; jamais émis en tant que true. Omis pour "none"les réponses , "fallback"un mode omis/null et une nouvelle tentative (202).
traceId string ID de trace pour le débogage.
retryAfter string Délai d’attente avant de réessayer, mis en forme sous forme de durée en secondes avec le "s" suffixe (par exemple, "60s" attendre 60 secondes). Présente uniquement lorsque l’analyse à la demande est en cours.
isAdult boolean Indique si la page web contient du contenu pour adultes.

Note

Les titlechamps , , lastUpdatedAtcontentisAdultet crawledAt les champs ne sont présents que dans les réponses réussies (200). Elles sont omises des réponses de nouvelle tentative (202).

Par exemple, une requête réussie avec "liveCrawl": "force" inclut "liveCrawlSucceeded": false uniquement lorsque le contenu obsolète est retourné. Une page non obsolète omet ce champ plutôt que de retourner true. Ce champ a la même signification dans la réponse structurée de l’outil Browse MCP.

Codes d’erreur

Code de statut Catégorie d’erreur Description Causes courantes
200 Success La demande a abouti. -
202 Accepté Demande acceptée pour le traitement (analyse dynamique). Analyse à la demande en cours
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 Les informations d’identification valides, mais la demande ne peut pas être remplie. La clé API ne dispose pas des autorisations requises, de l’URL bloquée par la stratégie, du contenu filtré
404 Introuvable Document introuvable. URL non valide ou inaccessible
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
430 Trop d’analyses à la demande Trop d’analyses à la demande. Demandes d’analyse dynamique excessives
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 devidéos recherche | d’actualités Recherche | d’imagesde recherche | d’actualités MCP |

  • Dernière mise à jour :