Referenční informace k rozhraní REST API

Koncový bod:POST https://api.microsoft.ai/v3/browse

Ukázkový požadavek:

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	Výchozí	Description
url	Ano	řetězec	-	Adresa URL webové stránky, která se má procházet.
maximální délka	No	integer	10000	Maximální početznakůch Maximální hodnota je 5 00000 znaků.
liveCrawl	No	řetězec	"none"	Řídí chování živého procházení. Hodnoty: "none" (vrací pouze indexovaný obsah), "náhradní" (procházení, pokud adresa URL nebyla nalezena v indexu), "force" (požadavek na čerstvou aktualizaci i v případě, že existuje indexovaný obsah). Všimněte si, že pokud se adresa URL nenajde v indexu, vrátí rozhraní API kód chyby 404 (adresa URL nebyla nalezena).
includeWebLinks	No	boolean	Nepravda	Zahrňte odchozí hypertextové odkazy ze stránky.
renderDynamicPages	No	boolean	Nepravda	Povolení vykreslování JavaScriptu pro snímek obrazovky s dynamickým obsahem Funguje pouze v případech, kdy je liveCrawl nastavený na "náhradní".
includeImageLinks	No	boolean	Nepravda	Zahrňte adresy URL obrázků ze stránky.
jazyk	No	řetězec	"en"	Kód jazyka (2 písmena ISO 639-1). Úplný seznam najdete v části Podporované jazyky .
oblast	No	řetězec	"US"	Kód oblasti (kód země/oblasti 2 písmen). Úplný seznam najdete v části Podporované oblasti .
Formát obsahu	No	řetězec	"html"	Formát obsahu webové stránky, který se má vrátit. Může to být "text", "html" nebo "markdown".

Hlavičky požadavku

Field	Typ	Description
hostitel	řetězec	Hostitel pro rozhraní API Microsoft AI: api.microsoft.ai.
x-apikey nebo authorization	řetězec	Váš klíč rozhraní API nebo Entra ID přístupový token pro ověřování.
typ obsahu	řetězec	Typ MIME textu požadavku. Použijte application/json.

Response

Field	Typ	Description
url	řetězec	Adresa URL webové stránky.
title	řetězec	Název webové stránky.
obsah	řetězec	Extrahovaný obsah webové stránky (neboli uzemnění).
lastUpdatedAt	řetězec	Datum poslední aktualizace webové stránky se řídí formátem ISO8601.
crawledAt	řetězec	Datum posledního procházení webové stránky se řídí formátem ISO8601.
liveCrawlSucceed	logická hodnota (volitelné)	Zobrazí se pouze tehdy false , když úspěšný požadavek liveCrawl: "force" vrátí zastaralou stránku. Vynecháno pro nezastaralé stránky; nikdy nevygenerováno jako true. Vynecháno pro "none", "fallback"vynechaný/null režim a opakovat (202) odpovědi.
traceId	řetězec	ID trasování pro ladění
retryAfter	řetězec	Doba čekání před opakováním, formátovaná jako doba trvání v sekundách s "s" příponou (např "60s" . znamená čekání 60 sekund). Probíhá pouze v době, kdy probíhá procházení na vyžádání.
isAdult	boolean	Označuje, jestli webová stránka obsahuje obsah pro dospělé.

Note

Pole title, , isAdultcontentlastUpdatedAta crawledAt pole jsou přítomny pouze v úspěšných (200) odpovědích. Z opakování (202) odpovědí se vynechá.

Například úspěšný požadavek s zahrnutím "liveCrawl": "force" pouze "liveCrawlSucceeded": false v případě, že se vrátí zastaralý obsah. Nestaralá stránka toto pole vynechá místo vrácení true. Toto pole má stejný význam ve strukturované odpovědi nástroje Browse MCP.

Kódy chyb

Kód stavu	Kategorie chyb	Description	Běžné příčiny
200	Success	Žádost byla úspěšná.	-
202	Akceptováno	Žádost byla přijata ke zpracování (živé procházení).	Probíhající procházení na vyžádání
400	Nesprávná žádost	Neplatné parametry požadavku.	Chybí požadovaná pole, neplatné hodnoty parametrů, chybně formátovaný JSON.
401	Neautorizováno	Ověřování se nezdařilo nebo chybí.	Neplatný klíč rozhraní API, chybějící hlavička x-apikey
403	Zakázáno	Platné přihlašovací údaje, ale požadavek nelze splnit.	Klíč rozhraní API nemá požadovaná oprávnění, adresu URL blokovanou zásadami, filtrovaný obsah
404	Nenalezeno	Dokument nebyl nalezen.	Neplatná nebo nepřístupná adresa URL
410	Pryč	Vyžaduje se HTTPS.	Požadavek provedený přes PROTOKOL HTTP místo HTTPS
415	Nepodporovaný typ média	Typ obsahu není podporován.	Chybějící nebo nesprávná hlavička typu obsahu
429	Příliš mnoho požadavků	Byl překročen limit rychlosti.	Příliš mnoho požadavků v časovém intervalu
430	Příliš mnoho procházení na vyžádání	Příliš mnohoprocházeních	Nadměrné požadavky na živé procházení
500	Vnitřní chyba serveru	Neočekávaná chyba serveru	Dočasný problém se serverem
503	Služba není k dispozici	Služba je dočasně nedostupná.	Údržba nebo dočasný výpadek
504	Časový limit brány	Vypršel časový limit požadavku.	Upstreamový časový limit služby

Podrobné pokyny pro zpracování chyb najdete v tématu Zpracování chyb.

---

Viz také:Web Search | Videos Search | ImagesSearch | Images Search | MCP