Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Punto final:POST https://api.microsoft.ai/v3/browse
Solicitud de ejemplo:
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
| Parámetro | Required | Tipo | Default | Description |
|---|---|---|---|---|
| url | Sí | string | - | Dirección URL de la página web que se va a examinar. |
| longitud máxima | No | integer | 10000 | Número máximo de caracteres en el campo de contenido en respuesta. El valor máximo es de 500000 caracteres. |
| liveCrawl | No | string | "none" | Controla el comportamiento del rastreo en vivo. Valores: "none" (solo devuelve contenido indexado), "reserva" (rastreo si la dirección URL no se encuentra en el índice), "force" (solicite un rastreo nuevo aunque exista contenido indexado). Tenga en cuenta que para el valor "none", si la dirección URL no se encuentra en el índice, la API devolverá el código de error 404 (no se encontró la dirección URL). |
| includeWebLinks | No | booleano | falso | Incluya hipervínculos salientes de la página. |
| renderDynamicPages | No | booleano | falso | Habilite la representación de JavaScript para la captura de pantalla de contenido dinámico. Solo funciona cuando liveCrawl está establecido en "reserva". |
| includeImageLinks | No | booleano | falso | Incluya direcciones URL de imagen desde la página. |
| idioma | No | string | "en" | El código de idioma (ISO 639-1 de 2 letras). Consulte Idiomas admitidos para obtener la lista completa. |
| region | No | string | "US" | Código de región (código de país o región de 2 letras). Consulte Regiones admitidas para obtener la lista completa. |
| contentFormat | No | string | "html" | Formato del contenido de la página web que se va a devolver. Puede ser "text", "html" o "markdown". |
Encabezados de solicitud
| Field | Tipo | Description |
|---|---|---|
| host | string | Host para las API de IA de Microsoft: api.microsoft.ai. |
| x-apikey o Authorization | string | La clave de API o Entra ID token de acceso para la autenticación. |
| content-type (tipo de contenido) | string | Tipo MIME del cuerpo de la solicitud. Utilice application/json. |
Respuesta
| Field | Tipo | Description |
|---|---|---|
| url | string | Dirección URL de la página web. |
| title | string | El título de la página web. |
| contenido | string | Contenido extraído de la página web (también conocido como tierra). |
| lastUpdatedAt | string | La última fecha actualizada de la página web sigue ISO8601 formato. |
| crawledAt | string | La última fecha rastreada de la página web sigue ISO8601 formato. |
| liveCrawlSucceed | booleano (opcional) | Solo está presente como false cuando una solicitud correcta con liveCrawl: "force" devuelve una página obsoleta. Se omite para páginas no obsoletas; nunca se emitió como true. Se omite para "none", "fallback", un modo omitido o null y las respuestas de reintento (202). |
| traceId | string | Identificador de seguimiento para la depuración. |
| retryAfter | string | Tiempo de espera antes de reintentar, con formato de duración en segundos con el "s" sufijo (por ejemplo, "60s" significa esperar 60 segundos). Solo está presente cuando el rastreo a petición está en curso. |
| isAdult | booleano | Indica si la página web contiene contenido para adultos. |
Note
Los titlecampos , content, isAdult, lastUpdatedAty crawledAt solo están presentes en respuestas correctas (200). Se omiten de las respuestas de reintento (202).
Por ejemplo, una solicitud correcta con "liveCrawl": "force" incluye "liveCrawlSucceeded": false solo cuando se devuelve contenido obsoleto. Una página no obsoleta omite este campo en lugar de devolver true. Este campo tiene el mismo significado en la respuesta estructurada de la herramienta Examinar MCP.
Códigos de error
| Código de estado | Categoría de error | Description | Causas comunes |
|---|---|---|---|
| 200 | Success | La solicitud tuvo éxito. | - |
| 202 | Aceptado | Solicitud aceptada para el procesamiento (rastreo en directo). | Rastreo a petición en curso |
| 400 | Solicitud incorrecta | Parámetros de solicitud no válidos. | Faltan campos obligatorios, valores de parámetro no válidos, JSON con formato incorrecto |
| 401 | Unauthorized | Error de autenticación o falta. | Clave de API no válida, falta el encabezado x-apikey |
| 403 | Prohibida | Credenciales válidas, pero no se puede completar la solicitud. | La clave de API carece de los permisos necesarios, la dirección URL bloqueada por directiva, el contenido filtrado |
| 404 | No encontrado | No se encontró el documento. | Dirección URL no válida o inaccesible |
| 410 | Pasado (Gone) | SE requiere HTTPS. | Solicitud realizada a través de HTTP en lugar de HTTPS |
| 415 | Tipo de medio no admitido | No se admite el tipo de contenido. | Falta o falta un encabezado de tipo de contenido incorrecto |
| 429 | Demasiadas solicitudes | Se superó el límite de velocidad. | Demasiadas solicitudes en el período de tiempo |
| 430 | Demasiados rastreos a petición | Demasiados rastreos a petición. | Solicitudes de rastreo en vivo excesivas |
| 500 | Error interno del servidor | Error inesperado del servidor. | Problema de servidor temporal |
| 503 | Servicio no disponible | El servicio no está disponible temporalmente. | Interrupción temporal o mantenimiento |
| 504 | Tiempo de espera de puerta de enlace | Se ha agotado el tiempo de espera para la solicitud. | Tiempo de espera del servicio ascendente |
Para obtener instrucciones detalladas sobre el control de errores, consulte Control de errores.
Consulte también:Web Search | Videos Search | News Search | Images Search | MCP