Referensi REST API Pencarian Berita

Titik Akhir:POST https://api.microsoft.ai/v3/search/news

Permintaan Sampel:

curl -X POST "https://api.microsoft.ai/v3/search/news" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "latest VC funding in tech",
    "maxResults": 10,
    "language": "en",
    "region": "US",
    "maxLength": 3000,
    "contentFormat": "passage"
  }'

Parameters

Parameter	Required	Type	Default	Description
kueri	Yes	string	-	Kueri pencarian untuk hasil berita. Panjang maksimum adalah 1000 karakter.
maxResults	No	integer	10	Jumlah maksimum hasil yang akan dikembalikan. Pengaturan awal adalah 10. Nilai maksimum adalah 20.
language	No	string	"en"	Kode bahasa ISO 639-1 2 huruf untuk bahasa antarmuka dalam hasil pencarian. Lihat Bahasa yang Didukung untuk daftar lengkapnya.
region	No	string	"US"	Kode negara/wilayah 2 huruf tempat hasilnya harus berasal (misalnya "US", "JP", "GB", dll.). Lihat Wilayah yang Didukung untuk daftar lengkapnya.
lokasi	No	string	-	Informasi lokasi dalam format "lat:<float>; long:<float>", misalnya "lat:40.753250; long:-74.003807".
contentFormat	No	string	"bagian" ("teks" dengan akses dokumen lengkap)	passage mengembalikan bagian dari setiap hasil yang paling relevan dengan kueri (disarankan untuk grounding). text, html dan markdown mengembalikan dokumen lengkap dan hanya berlaku untuk aplikasi dengan akses dokumen lengkap; lihat Bagian dan format konten. Atur pada setiap permintaan.
panjang maksimum	No	integer	3000 (10000 dengan akses dokumen penuh)	Karakter maksimum dalam content per hasil, 1 hingga 500000. Tanpa akses dokumen penuh, content paling banyak 3000 karakter. Lihat Default dan batasan. Atur pada setiap permintaan.

Format konten

Atur contentFormat = passage untuk mendapatkan bagian dari setiap hasil yang paling relevan dengan kueri, hingga maxLength karakter (3000 adalah titik awal yang baik). Ini adalah format yang direkomendasikan untuk grounding; lihat Apa itu passage, dan mengapa menggunakannya? di FAQ. Aplikasi dengan akses dokumen lengkap juga dapat meminta dokumen lengkap sebagai text, html atau markdown; untuk aplikasi lain, format tersebut mengembalikan HTTP 403. Lihat Bagian dan format konten.

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

Respons Berita

Field	Type	Description
newsResults	array newsResult	Daftar hasil artikel berita.
instrumentationClickBase	string	URL Dasar untuk mengeklik permintaan ping. Tambahkan instrumentationSuffix nilai dari item hasil untuk membentuk URL ping lengkap. Hanya ada untuk aplikasi dengan bendera profil EnableInstrumentationPing. Catatan: Klik pengguna juga dapat dicatat menggunakan pengalihan URL. Ketika pengalihan diaktifkan, tidak ada tindakan yang diperlukan untuk mencatat klik Pengguna, dan instrumentationClickBase tidak akan disertakan dalam respons. Lihat Panduan instrumentasi untuk instruksi penyiapan.
instrumentationCitationBase	string	URL Dasar untuk permintaan ping log LLM. Tambahkan payload DATA untuk membentuk URL ping lengkap. Hanya ada untuk aplikasi dengan bendera profil EnableInstrumentationPing.
traceId	string	ID pelacakan untuk penelusuran kesalahan.

newsResult

Field	Type	Description
title	string	Judul berita.
url	string	URL sumber artikel berita. Untuk pengguna Tiongkok dengan pengalihan URL diaktifkan, bidang ini sebagai gantinya berisi URL pengalihan yang sama dengan clickUrl.
domain	string	Host tujuan untuk hasilnya. Dikembalikan hanya untuk pengguna Tiongkok dengan pengalihan URL diaktifkan.
isi	string	Konten halaman web terperinci (alias grounding) dari hasil berita.
gambar kecil	objek gambar mini	Gambar mini artikel berita.
terakhirDiperbaruiPada	string	Tanggal terakhir berita yang diperbarui, dalam format ISO8601 UTC.
crawledAt	string	Tanggal perayapan terakhir berita, mengikuti format ISO8601.
language	string	Bahasa artikel berita, menggunakan kode bahasa ISO 639-1.
sumber	string	Publisher nama, seperti "USA TODAY | MSN", "CNN", dll.
isAdult	Boolean	Menunjukkan apakah kontennya dewasa.
klikUrl	string	Alihkan URL yang memproksi klik melalui Bing. Hanya ada saat pengalihan klik diaktifkan.
instrumentationSuffix	string	Akhiran untuk ditambahkan ke basis URL ping instrumentasi untuk item hasil ini. Digunakan sebagai nilai K untuk URL ping instrumentasi dan clickUrl pengalihan. Ada saat ping instrumentasi diaktifkan.

Note

lastUpdatedAt bidang bersifat opsional – yaitu, Anda mungkin melihat nilai kosong untuk bidang ini.

gambar kecil

Field	Type	Description
url	string	URL thumbnail.
width	integer	Lebar gambar mini, dalam piksel.
height	integer	Tinggi gambar mini, dalam piksel.

Note

thumbnail juga merupakan objek respons opsional - mungkin tidak tersedia untuk hasil berita tertentu.

Kode Kesalahan

Kode Status	Kategori Kesalahan	Description	Penyebab Umum
200	Keberhasilan	Permintaan itu berhasil.	-
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 izinnya tidak mencukup.	Kunci API tidak memiliki izin yang diperlukan
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
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 | Video Pencarian | WebTelusuri | Gambar Cari | MCP