Informazioni di riferimento sulle API REST

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

Richiesta di esempio:

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

Parametro	Required	Type	Default	Description
url	Yes	string	-	URL della pagina Web da esplorare.
lunghezza massima	No	integer	10000	Numero massimo di caratteri nel campo contenuto in risposta. Il valore massimo è 500000 caratteri.
liveCrawl	No	string	"nessuno"	Controlla il comportamento di ricerca per indicizzazione in tempo reale. Valori: "none" (restituisce solo contenuto indicizzato), "fallback" (ricerca per indicizzazione se l'URL non trovato nell'indice), "force" (richiedere una nuova ricerca per indicizzazione anche se esiste contenuto indicizzato). Si noti che per il valore "none", se l'URL non viene trovato nell'indice, l'API restituirà il codice di errore 404 (URL non trovato).
includeWebLinks	No	boolean	falso	Includere collegamenti ipertestuali in uscita dalla pagina.
renderDynamicPages	No	boolean	falso	Abilitare il rendering JavaScript per lo screenshot del contenuto dinamico. Funziona solo quando liveCrawl è impostato su "fallback".
includeImageLinks	No	boolean	falso	Includere gli URL delle immagini dalla pagina.
language	No	string	"en"	Codice linguistico (ISO 639-1 di 2 lettere). Per l'elenco completo, vedere Lingue supportate .
region	No	string	"US"	Codice dell'area geografica (codice paese/area geografica di 2 lettere). Per l'elenco completo, vedere Aree supportate .
contentFormat	No	string	"html"	Formato del contenuto della pagina Web da restituire. Può essere "text", "html" o "markdown".

Intestazioni della richiesta

Field	Type	Description
host	string	Host per le API di intelligenza artificiale Microsoft: api.microsoft.ai.
x-apikey o autorizzazione	string	La chiave API o Entra ID token di accesso per l'autenticazione.
tipo di contenuto	string	Tipo MIME del corpo della richiesta. Utilizzare il application/json.

Risposta

Field	Type	Description
url	string	URL della pagina Web.
title	string	Titolo della pagina Web.
contenuto	string	Contenuto estratto della pagina Web (noto anche come terra).
ultimoAggiornatoAt	string	La data dell'ultimo aggiornamento della pagina Web segue ISO8601 formato.
ricerca per indicizzazioneAt	string	L'ultima data sottoposta a ricerca per indicizzazione della pagina Web segue ISO8601 formato.
liveCrawlSucceeded	booleano (facoltativo)	Presente solo quando false una richiesta con esito positivo restituisce liveCrawl: "force" una pagina non aggiornata. Omesso per le pagine non aggiornate; mai emesso come true. Omesso per "none", "fallback", una modalità omessa/null e riprovare (202) risposte.
traceId	string	ID traccia per il debug.
retryAfter	string	Tempo di attesa prima di riprovare, formattato come durata in secondi con il "s" suffisso (ad esempio, "60s" significa attendere 60 secondi). Presente solo quando è in corso una ricerca per indicizzazione su richiesta.
isAdult	boolean	Indica se la pagina Web contiene contenuto per adulti.

Note

I titlecampi , isAdultcontent, lastUpdatedAt, e crawledAt sono presenti solo nelle risposte riuscite (200). Vengono omessi dalle risposte di ripetizione (202).

Ad esempio, una richiesta con esito positivo include "liveCrawl": "force""liveCrawlSucceeded": false solo quando viene restituito contenuto non aggiornato. Una pagina non non aggiornata omette questo campo anziché restituire true. Questo campo ha lo stesso significato nella risposta strutturata dello strumento Sfoglia MCP.

Codici di errore

Codice di stato	Categoria errore	Description	Cause comuni
200	Operazione completata	La richiesta è stata accolta.	-
202	Accettato	Richiesta accettata per l'elaborazione (ricerca per indicizzazione in tempo reale).	Ricerca per indicizzazione su richiesta in corso
400	Richiesta non valida	Parametri di richiesta non validi.	Campi obbligatori mancanti, valori di parametro non validi, JSON in formato non valido
401	Unauthorized	Autenticazione non riuscita o mancante.	Chiave API non valida, intestazione x-apikey mancante
403	Non consentito	Credenziali valide, ma la richiesta non può essere soddisfatta.	La chiave API non dispone delle autorizzazioni necessarie, l'URL bloccato dai criteri, il contenuto filtrato
404	Non trovato	Documento non trovato.	URL non valido o inaccessibile
410	Sparito	HTTPS obbligatorio.	Richiesta effettuata tramite HTTP invece di HTTPS
415	Tipo di supporto non supportato	Tipo di contenuto non supportato.	Intestazione di tipo contenuto mancante o non corretta
429	Troppe richieste	Limite di velocità superato.	Troppe richieste nell'intervallo di tempo
430	Troppe ricerche per indicizzazione su richiesta	Troppe ricerche per indicizzazione su richiesta.	Richieste di ricerca per indicizzazione in tempo reale eccessive
500	Errore interno del server	Errore server imprevisto.	Problema temporaneo del server
503	Servizio non disponibile	Servizio temporaneamente non disponibile.	Manutenzione o interruzione temporanea
504	Timeout gateway	Tempo di attesa della richiesta scaduto.	Timeout del servizio Upstream

Per indicazioni dettagliate sulla gestione degli errori, vedere Gestione degli errori.

---

Vedere anche:Ricerca video web Ricerca | | immaginiricerca | notizie Ricerca | MCP