REST-API-Referenz durchsuchen

Endpunkt:POST https://api.microsoft.ai/v3/browse

Beispielanforderung:

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	Typ	Vorgabe	Description
url	Yes	string	-	Die URL der webseite, die durchsucht werden soll.
Maximale Länge	No	integer	10000	Die maximale Anzahl von Zeichen im Inhaltsfeld als Antwort. Der Maximalwert beträgt 500000 Zeichen.
liveCrawl	No	string	"none"	Steuert das Verhalten der Live-Durchforstung. Werte: "none" (nur indizierte Inhalte zurückgeben), "Fallback" (Durchforstung, wenn die URL nicht im Index gefunden wurde), "force" (Anfordern einer neuen Durchforstung, auch wenn indizierte Inhalte vorhanden sind). Beachten Sie, dass für "none"-Wert, wenn die URL nicht im Index gefunden wird, api den Fehlercode 404 zurückgibt (URL nicht gefunden).
includeWebLinks	No	boolean	Falsch	Schließen Sie ausgehende Links von der Seite ein.
renderDynamicPages	No	boolean	Falsch	Aktivieren sie das JavaScript-Rendering für den Screenshot dynamischer Inhalte. Funktioniert nur, wenn liveCrawl auf "Fallback" festgelegt ist.
includeImageLinks	No	boolean	Falsch	Schließen Sie Bild-URLs von der Seite ein.
language	No	string	„de“	Der Sprachcode (2 Buchstaben ISO 639-1). Die vollständige Liste finden Sie unter "Unterstützte Sprachen ".
region	No	string	"US"	Der Regionscode (2-Buchstaben-Länder-/Regionscode). Die vollständige Liste finden Sie unter "Unterstützte Regionen ".
contentFormat	No	string	"html"	Das Format des zurückzugebenden Webseiteninhalts. Kann "text", "html" oder "markdown" sein.

Anforderungsheader

Feld	Typ	Description
host	string	Host für Microsoft AI-APIs: api.microsoft.ai.
x-apikey oder Autorisierung	string	Ihr API-Schlüssel oder Entra ID Zugriffstoken für die Authentifizierung.
Inhaltstyp	string	MIME-Typ des Anforderungstexts. Verwenden Sie application/json.

Antwort

Feld	Typ	Description
url	string	Die URL der Webseite.
title	string	Der Titel der Webseite.
Inhalt	string	Der extrahierte Inhalt der Webseite (auch als Erdung bezeichnet).
lastUpdatedAt	string	Das datum der letzten Aktualisierung der Webseite folgt ISO8601 Format.
crawledAt	string	Das letzte durchforstete Datum der Webseite folgt ISO8601 Format.
liveCrawlSucceeded	boolescher Wert (optional)	Nur vorhanden, als false wenn eine erfolgreiche Anforderung mit liveCrawl: "force" einer veralteten Seite zurückgegeben wird. Wird für nicht veraltete Seiten weggelassen; nie als ausgegeben als true. Ausgelassen für "none", "fallback"einen ausgelassenen/null-Modus und wiederholen (202) Antworten.
traceId	string	Ablaufverfolgungs-ID für das Debuggen.
retryAfter	string	Zeit bis zum Erneuten Wiederholen, die als Dauer in Sekunden mit dem "s" Suffix formatiert ist (z. B "60s" . 60 Sekunden warten). Nur vorhanden, wenn die On-Demand-Durchforstung ausgeführt wird.
isAdult	boolean	Gibt an, ob die Webseite erwachsene Inhalte enthält.

Note

Die titleFelder , content, , isAdultund crawledAtlastUpdatedAtFelder sind nur in erfolgreichen Antworten (200) vorhanden. Sie werden aus Wiederholungsantworten (202) weggelassen.

Beispielsweise enthält "liveCrawlSucceeded": false eine erfolgreiche Anforderung nur "liveCrawl": "force" dann, wenn veraltete Inhalte zurückgegeben werden. Auf einer nicht veralteten Seite wird dieses Feld nicht zurückgegeben, sondern trueweggelassen. Dieses Feld hat die gleiche Bedeutung in der strukturierten Antwort des Browse MCP-Tools.

Fehlercodes

Statuscode	Fehlerkategorie	Description	Häufige Ursachen
200	Success	Die Anfrage war erfolgreich.	-
202	Akzeptiert	Anforderung für die Verarbeitung akzeptiert (Live-Durchforstung).	On-Demand-Durchforstung wird ausgeführt
400	Ungültige Anforderung	Ungültige Anforderungsparameter.	Fehlende erforderliche Felder, ungültige Parameterwerte, falsch formatierter JSON-Code
401	Unauthorized	Fehler bei der Authentifizierung oder fehlender Authentifizierung.	Ungültiger API-Schlüssel, fehlender x-apikey-Header
403	Verboten	Gültige Anmeldeinformationen, anforderung kann jedoch nicht erfüllt werden.	API-Schlüssel fehlt an erforderlichen Berechtigungen, URL blockiert durch Richtlinie, gefilterter Inhalt
404	Nicht gefunden	Das Dokument wurde nicht gefunden.	Ungültige oder nicht zugängliche URL
410	Nicht vorhanden (Gone)	HTTPS erforderlich.	Anforderung über HTTP anstelle von HTTPS
415	Nicht unterstützter Medientyp	Der Inhaltstyp wird nicht unterstützt.	Fehlender oder falscher Inhaltstypheader
429	Zu viele Anforderungen	Das Ratenlimit wurde überschritten.	Zu viele Anforderungen im Zeitfenster
430	Zu viele On-Demand-Durchforstungen	Zu viele On-Demand-Durchforstungen.	Übermäßige Live-Durchforstungsanforderungen
500	Interner Serverfehler	Unerwarteter Serverfehler.	Temporäres Serverproblem
503	Dienst nicht verfügbar	Der Dienst ist vorübergehend nicht verfügbar.	Wartung oder vorübergehender Ausfall
504	Gateway-Zeitüberschreitung	Zeitüberschreitung bei der Anforderung.	Timeout des Upstream-Diensts

Ausführliche Anleitungen zur Fehlerbehandlung finden Sie unter "Fehlerbehandlung".

---

Siehe auch:Web search | Videos Search | News Search | Images Search | MCP