Przeglądanie dokumentacji interfejsu API REST

Punkt końcowy:POST https://api.microsoft.ai/v3/browse

Przykładowe żądanie:

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	Default	Description
url	Yes	ciąg	-	Adres URL strony internetowej do przeglądania.
maksymalna długość	No	liczba całkowita	10000	Maksymalna liczba znaków w polu zawartości w odpowiedzi. Maksymalna wartość to 500000 znaków.
liveCrawl	No	ciąg	"brak"	Steruje zachowaniem przeszukiwania na żywo. Wartości: "none" (zwracana jest tylko zawartość indeksowana), "rezerwowa" (przeszukiwanie, jeśli nie znaleziono adresu URL w indeksie), "force" (żądanie nowego przeszukiwania, nawet jeśli istnieje indeksowana zawartość). Należy pamiętać, że w przypadku wartości "none" jeśli adres URL nie zostanie znaleziony w indeksie, interfejs API zwróci kod błędu 404 (nie znaleziono adresu URL).
includeWebLinks	No	boolean	false	Dołącz hiperłącza wychodzące ze strony.
renderDynamicPages	No	boolean	false	Włącz renderowanie w języku JavaScript na potrzeby zrzutu ekranu zawartości dynamicznej. Działa tylko wtedy, gdy parametr liveCrawl ma wartość "fallback".
includeImageLinks	No	boolean	false	Dołącz adresy URL obrazów ze strony.
język	No	ciąg	"en"	Kod języka (2 litery ISO 639-1). Aby uzyskać pełną listę, zobacz Obsługiwane języki .
region	No	ciąg	"US"	Kod regionu (2-literowy kod kraju/regionu). Aby uzyskać pełną listę, zobacz Obsługiwane regiony .
contentFormat (format treści)	No	ciąg	"html"	Format zawartości strony internetowej do zwrócenia. Może to być "text", "html" lub "markdown".

Nagłówki żądań

Pole	Typ	Description
gospodarz	ciąg	Host dla interfejsów API sztucznej inteligencji Microsoft: api.microsoft.ai.
x-apikey lub authorization	ciąg	Klucz interfejsu API lub token dostępu Entra ID na potrzeby uwierzytelniania.
typ zawartości	ciąg	Typ MIME treści żądania. Użyj application/json.

Odpowiedź

Pole	Typ	Description
url	ciąg	Adres URL strony internetowej.
title	ciąg	Tytuł strony internetowej.
zawartość	ciąg	Wyodrębniona zawartość strony internetowej (czyli uziemienia).
lastUpdatedAt	ciąg	Data ostatniej aktualizacji strony internetowej jest zgodna z formatem ISO8601.
crawledAt	ciąg	Data ostatniego przeszukania strony internetowej jest zgodna z formatem ISO8601.
liveCrawlSucceeded	wartość logiczna (opcjonalnie)	Występuje false tylko wtedy, gdy pomyślne żądanie z liveCrawl: "force" zwraca nieaktualną stronę. Pominięto dla stron nieświeżych; nigdy nie emitowane jako true. Pominięto dla "none", "fallback", pominięty/null tryb i ponów próbę (202) odpowiedzi.
traceId	ciąg	Identyfikator śledzenia na potrzeby debugowania.
ponawianie ponawiania prób	ciąg	Czas oczekiwania przed ponowną próbą, sformatowany jako czas trwania w sekundach z sufiksem "s" (np "60s" . oznacza odczekanie 60 sekund). Występuje tylko wtedy, gdy przeszukiwanie na żądanie jest w toku.
isAdult	boolean	Wskazuje, czy strona internetowa zawiera zawartość dla dorosłych.

Note

Pola title, content, isAdult, lastUpdatedAti crawledAt są obecne tylko w odpowiedziach zakończonych powodzeniem (200). Są one pomijane z ponownych prób (202) odpowiedzi.

Na przykład pomyślne żądanie z elementem "liveCrawl": "force" zawiera "liveCrawlSucceeded": false tylko wtedy, gdy zwracana jest nieaktualna zawartość. Strona nieodświeżająca pomija to pole zamiast zwracać truewartość . To pole ma takie samo znaczenie w odpowiedzi ze strukturą narzędzia Browse MCP.

Kody błędów

Kod stanu	Kategoria błędów	Description	Typowe przyczyny
200	Powodzenie	Żądanie zakończyło się pomyślnie.	-
202	Zaakceptowano	Żądanie zaakceptowane do przetwarzania (przeszukiwanie na żywo).	Przeszukiwanie na żądanie jest w toku
400	Nieprawidłowe żądanie	Nieprawidłowe parametry żądania.	Brak wymaganych pól, nieprawidłowe wartości parametrów, nieprawidłowo sformułowany kod JSON
401	Brak autoryzacji	Uwierzytelnianie nie powiodło się lub nie powiodło się.	Nieprawidłowy klucz interfejsu API, brak nagłówka x-apikey
403	Dostęp zabroniony	Prawidłowe poświadczenia, ale nie można spełnić żądania.	Klucz interfejsu API nie ma wymaganych uprawnień, adres URL zablokowany przez zasady, filtrowaną zawartość
404	Nie znaleziono	Nie można odnaleźć dokumentu.	Nieprawidłowy lub niedostępny adres URL
410	Zniknęło	Wymagany protokół HTTPS.	Żądanie wykonane za pośrednictwem protokołu HTTP zamiast HTTPS
415	Nieobsługiwany typ nośnika	Typ zawartości nie jest obsługiwany.	Brak lub niepoprawny nagłówek typu zawartości
429	Zbyt wiele żądań	Przekroczono limit szybkości.	Zbyt wiele żądań w przedziale czasu
430	Zbyt wiele przeszukiwań na żądanie	Zbyt wiele przeszukiwań na żądanie.	Nadmierne żądania przeszukiwania na żywo
500	Wewnętrzny błąd serwera	Nieoczekiwany błąd serwera.	Tymczasowy problem z serwerem
503	Usługa niedostępna	Usługa jest tymczasowo niedostępna.	Konserwacja lub tymczasowa awaria
504	Przekroczono limit czasu bramy	Upłynął limit czasu żądania.	Limit czasu usługi nadrzędnej

Aby uzyskać szczegółowe wskazówki dotyczące obsługi błędów, zobacz Obsługa błędów.

---

Zobacz również: Wyszukiwaniewideo wyszukiwania wiadomości | w Sieci Web | Wyszukiwanieobrazów wyszukiwania | w internecieMCP |