Обзор справочника по REST API

Конечная точка:POST https://api.microsoft.ai/v3/browse

Пример запроса:

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	-	URL-адрес веб-страницы для просмотра.
максимальная длина	No	integer	10000	Максимальное количество символов в поле содержимого в ответе. Максимальное значение — 500000 символов.
liveCrawl	No	string	"нет"	Управляет поведением динамического обхода контента. Значения: "none" (только возвращаемое индексированного содержимого), "резервный" (обход, если URL-адрес не найден в индексе), "force" (запрос нового обхода, даже если индексированного содержимого существует). Обратите внимание, что для значения none, если URL-адрес не найден в индексе, API вернет код ошибки 404 (URL-адрес не найден).
includeWebLinks	No	boolean	неправда	Включите исходящие гиперссылки со страницы.
renderDynamicPages	No	boolean	неправда	Включение отрисовки JavaScript для динамического снимка экрана содержимого. Работает только в том случае, если для liveCrawl задано значение "резервный".
includeImageLinks	No	boolean	неправда	Включите URL-адреса изображения на странице.
language	No	string	"en"	Языковой код (2-буквенный ISO 639-1). Полный список см. на поддерживаемых языках .
region	No	string	"US"	Код региона (2-буквенный код страны или региона). Полный список см. в поддерживаемых регионах .
contentFormat	No	string	"html"	Формат возвращаемого содержимого веб-страницы. Может быть "text", "html" или "markdown".

Заголовки запроса

Field	Type	Description
host	string	Узел для API Microsoft ИИ: api.microsoft.ai
x-apikey или authorization	string	Ключ API или маркер доступа Entra ID для проверки подлинности.
тип контента	string	Тип MIME текста запроса. Используйте application/json.

Response

Field	Type	Description
url	string	URL-адрес веб-страницы.
title	string	Заголовок веб-страницы.
содержимое	string	Извлеченное содержимое веб-страницы (ака приземления).
lastUpdatedAt	string	Последняя обновленная дата веб-страницы следует ISO8601 формате.
обход контента	string	Последняя дата обхода веб-страницы следует ISO8601 формате.
liveCrawlSucceeded	boolean (необязательно)	Отображается только в том случае false , если успешный запрос liveCrawl: "force" возвращает устаревшую страницу. Опущен для неустареемых страниц; никогда не генерируется как true. Опущены для "none", "fallback"опущены или пустые режимы и ответы повторных попыток (202).
traceId	string	Идентификатор трассировки для отладки.
Повторная попытка После	string	Время ожидания до повтора, отформатированного в виде длительности в секундах с суффиксом "s" (например, "60s" означает ожидание 60 секунд). Присутствует только при выполнении обхода по запросу.
isAdult	boolean	Указывает, содержит ли веб-страница содержимое для взрослых.

Note

Поля title, и isAdultcontentlastUpdatedAtcrawledAt поля присутствуют только в успешных ответах (200). Они опущены из ответов на повторные попытки (202).

Например, успешный запрос включает "liveCrawl": "force""liveCrawlSucceeded": false только в том случае, если возвращается устаревшее содержимое. Неисчерпаемая страница пропускает это поле, а не возвращается true. Это поле имеет то же значение в структурированном ответе средства "Обзор MCP".

Коды ошибок

Код состояния	Категория ошибки	Description	Распространенные причины
200	Success	Запрос был выполнен успешно.	-
202	Акцептировано	Запрос, принятый для обработки (динамический обход).	Выполняется обход по запросу
400	ошибка запроса	Недопустимые параметры запроса.	Отсутствующие обязательные поля, недопустимые значения параметров, некорректный JSON
401	Unauthorized	Сбой проверки подлинности или отсутствие.	Недопустимый ключ API, отсутствующий заголовок x-apikey
403	Forbidden	Допустимые учетные данные, но запрос не может быть выполнен.	Ключ API не имеет необходимых разрешений, URL-адрес, заблокированный политикой, фильтруется содержимое
404	Не найдено	Документ не найден.	Недопустимый или недоступный URL-адрес
410	Отсутствует (Gone)	Требуется ПРОТОКОЛ HTTPS.	Запрос, сделанный по протоколу HTTP вместо HTTPS
415	Неподдерживаемый тип носителя	Тип контента не поддерживается.	Отсутствует или неправильный заголовок типа контента
429	Слишком много запросов	Превышено ограничение скорости.	Слишком много запросов в период времени
430	Слишком много обходов по запросу	Слишком много обходов по запросу.	Чрезмерные запросы динамического обхода
500	Внутренняя ошибка сервера	Непредвиденная ошибка сервера.	Проблема с временным сервером
503	Служба недоступна	Служба временно недоступна.	Обслуживание или временный сбой
504	Тайм-аут шлюза	Истекло время ожидания для запроса.	Время ожидания вышестоящей службы

Подробные инструкции по обработке ошибок см. в разделе "Обработка ошибок".

---

См. также:Поисквидео в Интернете | в | поискахновостей | поискаизображений | MCP