Telusuri referensi REST API

Titik Akhir:POST https://api.microsoft.ai/v3/browse

Permintaan Sampel:

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 halaman web untuk dijelajahi.
panjang maksimum No integer 10000 Jumlah maksimum karakter di bidang konten sebagai respons. Nilai maksimum adalah 500000 karakter.
liveCrawl No string "tidak ada" Mengontrol perilaku perayapan langsung. Nilai: "none" (hanya mengembalikan konten terindeks), "fallback" (perayapan jika URL tidak ditemukan dalam indeks), "force" (minta perayapan baru meskipun konten terindeks ada). Perhatikan bahwa untuk nilai "tidak ada", jika URL tidak ditemukan dalam indeks, API akan mengembalikan kode kesalahan 404 (URL tidak ditemukan).
includeWebLinks No Boolean tidak benar Sertakan hyperlink keluar dari halaman.
renderDynamicPages No Boolean tidak benar Aktifkan penyajian JavaScript untuk cuplikan layar konten dinamis. Hanya berfungsi ketika liveCrawl diatur ke "fallback".
includeImageLinks No Boolean tidak benar Sertakan URL gambar dari halaman.
language No string "en" Kode bahasa (2 huruf ISO 639-1). Lihat Bahasa yang Didukung untuk daftar lengkapnya.
region No string "US" Kode wilayah (kode negara/wilayah 2 huruf). Lihat Wilayah yang Didukung untuk daftar lengkapnya.
contentFormat No string "html" Format isi halaman web yang akan dikembalikan. Dapat berupa "text", "html", atau "markdown".

Header Permintaan

Field Type Description
host string Host untuk API AI Microsoft: api.microsoft.ai.
x-apikey atau Otorisasi string Kunci API Anda atau token akses Entra ID untuk autentikasi.
jenis konten string Jenis MIME isi permintaan. Gunakan application/json.

Jawaban

Field Type Description
url string URL halaman web.
title string Judul halaman web.
isi string Konten halaman web yang diekstrak (alias grounding).
terakhirDiperbaruiPada string Tanggal terakhir diperbarui dari halaman web, mengikuti format ISO8601.
crawledAt string Tanggal perayapan terakhir halaman web, mengikuti format ISO8601.
liveCrawlSucceeded boolean (opsional) Hanya ada saat false permintaan yang berhasil dengan liveCrawl: "force" mengembalikan halaman kedaluarsa. Dihilangkan untuk halaman yang tidak kedaluarsa; tidak pernah dipancarkan sebagai true. Dihilangkan untuk "none", "fallback", mode dihilangkan/null, dan coba lagi (202) respons.
traceId string ID pelacakan untuk penelusuran kesalahan.
retryAfter string Waktu untuk menunggu sebelum mencoba kembali, diformat sebagai durasi dalam detik dengan "s" akhiran (misalnya, "60s" berarti tunggu 60 detik). Hanya ada saat perayapan sesuai permintaan sedang berlangsung.
isAdult Boolean Menunjukkan apakah halaman web berisi konten dewasa.

Note

Bidang title, , isAdultcontent, lastUpdatedAt, dan crawledAt hanya ada dalam respons yang berhasil (200). Mereka dihilangkan dari respons coba lagi (202).

Misalnya, permintaan yang berhasil dengan "liveCrawl": "force" hanya menyertakan "liveCrawlSucceeded": false saat konten kedaluarsa dikembalikan. Halaman non-basi menghilangkan bidang ini daripada mengembalikan true. Bidang ini memiliki arti yang sama dalam respons terstruktur alat Browse MCP.

Kode Kesalahan

Kode Status Kategori Kesalahan Description Penyebab Umum
200 Keberhasilan Permintaan itu berhasil. -
202 Diterima Permintaan diterima untuk diproses (perayapan langsung). Perayapan sesuai permintaan sedang berlangsung
400 Permintaan Tidak Valid Parameter permintaan tidak valid. Bidang yang diperlukan hilang, nilai parameter tidak valid, JSON cacat
401 Unauthorized Autentikasi gagal atau hilang. Kunci API tidak valid, header x-apikey hilang
403 Forbidden Kredensial yang valid tetapi permintaan tidak dapat dipenuhi. Kunci API tidak memiliki izin yang diperlukan, URL yang diblokir oleh kebijakan, konten yang difilter
404 Tidak Ditemukan Dokumen tidak ditemukan. URL tidak valid atau tidak dapat diakses
410 Hilang HTTPS diperlukan. Permintaan yang dibuat melalui HTTP alih-alih HTTPS
415 Tipe Media yang Tidak Didukung Tipe isi tidak didukung. Header tipe konten yang hilang atau salah
429 Terlalu Banyak Permintaan Batas kecepatan terlampaui. Terlalu banyak permintaan dalam jendela waktu
430 Terlalu Banyak Perayapan Sesuai Permintaan Terlalu banyak perayapan sesuai permintaan. Permintaan perayapan langsung yang berlebihan
500 Kesalahan Server Internal Kesalahan server tak terduga. Masalah server sementara
503 Layanan Tidak Tersedia Layanan untuk sementara tidak tersedia. Pemeliharaan atau pemadaman sementara
504 Waktu Habis Gateway Waktu permintaan berakhir. Batas waktu layanan upstram

Untuk panduan penanganan kesalahan terperinci, lihat Penanganan Kesalahan.

Lihat juga:Pencarian | Web Video Pencarian | Gambar | Pencarian | BeritaMCP

  • Terakhir diperbarui pada