Bläddra i REST API-referens

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

Exempelbegäran:

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	Type	Default	Description
url	Yes	string	-	Webbadressen till webbsidan som ska bläddras.
maxlängd	No	integer	10000	Det maximala antalet tecken i innehållsfältet som svar. Maximalt värde är 500000 tecken.
liveCrawl	No	string	"ingen"	Styr beteendet för direktkrypning. Värden: "none" (returnerar endast indexerat innehåll), "reserv" (crawlning om URL inte hittades i index), "force" (begär en ny crawlning även om indexerat innehåll finns). Observera att för värdet "ingen" returnerar API:et 404-felkoden (URL hittades inte) om URL:en inte hittas i indexet.
includeWebLinks	No	boolean	falskt	Inkludera utgående hyperlänkar från sidan.
renderDynamicPages	No	boolean	falskt	Aktivera JavaScript-rendering för skärmbild av dynamiskt innehåll. Fungerar bara när liveCrawl är inställt på "reserv".
includeImageLinks	No	boolean	falskt	Ta med bild-URL:er från sidan.
language	No	string	"en"	Språkkoden (2-bokstavs ISO 639-1). Se Språk som stöds för den fullständiga listan.
region	No	string	"US"	Regionkoden (lands-/regionkod med två bokstäver). Se Regioner som stöds för den fullständiga listan.
contentFormat	No	string	"html"	Formatet på webbsidans innehåll som ska returneras. Kan vara "text", "html" eller "markdown".

Rubriker för begäran

Fält	Type	Description
host	string	Värd för Microsoft AI-API:er: api.microsoft.ai.
x-apikey eller auktorisering	string	Din API-nyckel eller Entra ID åtkomsttoken för autentisering.
innehållstyp	string	MIME-typ av begärandetext. Använd application/json.

Svar

Fält	Type	Description
url	string	Webbadressen till webbsidan.
title	string	Webbsidans rubrik.
innehåll	string	Det extraherade innehållet på webbsidan (även kallat jordning).
lastUpdatedAt	string	Webbsidans senast uppdaterade datum följer ISO8601 format.
crawledAt	string	Webbsidans senaste crawlade datum följer ISO8601 format.
liveCrawlSucceeded	booleskt värde (valfritt)	Visas endast som false när en lyckad begäran med liveCrawl: "force" returnerar en inaktuell sida. Utelämnas för inaktuella sidor. aldrig genereras som true. Utelämnas för "none", "fallback", ett utelämnat/null-läge och försök igen (202) svar.
traceId	string	Spårnings-ID för felsökning.
retryAfter	string	Tid att vänta innan du försöker igen, formaterad som en varaktighet i sekunder med suffixet "s" (t.ex. "60s" betyder vänta 60 sekunder). Finns endast när crawlning på begäran pågår.
isAdult	boolean	Anger om webbsidan innehåller innehåll som är olämpligt för barn.

Note

Fälten title, content, isAdult, lastUpdatedAtoch crawledAt finns bara i lyckade (200) svar. De utelämnas från återförsök (202) svar.

En lyckad begäran med "liveCrawl": "force" inkluderar "liveCrawlSucceeded": false till exempel endast när inaktuellt innehåll returneras. En inaktuell sida utelämnar det här fältet i stället för att truereturnera . Det här fältet har samma betydelse i verktyget Bläddra i MCP-verktygets strukturerade svar.

Felkoder

Statuskod	Felkategori	Description	Vanliga orsaker
200	Success	Begäran lyckades.	-
202	Accepted	Begäran har godkänts för bearbetning (direkt crawlning).	Crawlning på begäran pågår
400	Felaktig förfrågan	Ogiltiga parametrar för begäran.	Obligatoriska fält saknas, ogiltiga parametervärden, felaktigt formaterad JSON
401	Behörighet saknas	Autentiseringen misslyckades eller saknas.	Ogiltig API-nyckel, x-apikey-huvud saknas
403	Ej tillåtet	Giltiga autentiseringsuppgifter men begäran kan inte uppfyllas.	API-nyckeln saknar nödvändiga behörigheter, URL blockerad av princip, innehåll filtrerat
404	Hittades inte	Dokumentet hittades inte.	Ogiltig eller otillgänglig URL
410	Borta	HTTPS krävs.	Begäran som görs via HTTP i stället för HTTPS
415	Medietyp som inte stöds	Innehållstypen stöds inte.	Rubrik av innehållstyp saknas eller är felaktig
429	För många begäranden	Hastighetsgränsen har överskridits.	För många begäranden i tidsfönstret
430	För många crawlningar på begäran	För många crawlningar på begäran.	Överdrivna direktkrypningsbegäranden
500	Internt serverfel	Oväntat serverfel.	Problem med tillfällig server
503	Tjänsten är inte tillgänglig	Tjänsten är inte tillgänglig för tillfället.	Underhåll eller tillfälligt avbrott
504	Tidsgräns för gateway	Tidsgränsen för begäran har överskridits.	Timeout för överordnad tjänst

Detaljerad vägledning för felhantering finns i Felhantering.

---

Se även:Sök efternyhetssökningsbilder Sök efter nyhetssökningsbilder | | för webbsökningsvideor | |