REST API başvurusuna göz atın

Bitiş noktası:POST https://api.microsoft.ai/v3/browse

Örnek İstek:

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

Parametre Required Tür Default Description
url Yes string - Gözatmak için web sayfasının URL'si.
maksimumUzunluk No integer 10000 Yanıt olarak içerik alanındaki en fazla karakter sayısı. En yüksek değer 500000 karakterdir.
liveCrawl No string "hiçbiri" Canlı gezinme davranışını denetler. Değerler: "none" (yalnızca dizine alınan içeriği döndür), "geri dönüş" (dizinde URL bulunamazsa gezinme), "zorlama" (dizinlenmiş içerik olsa bile yeni gezinme iste). "Yok" değeri için URL dizinde bulunmazsa API'nin 404 hata kodu döndüreceğini (URL bulunamadı) unutmayın.
includeWebLinks No boolean yanlış Sayfadan giden köprüler ekleyin.
renderDynamicPages No boolean yanlış Dinamik içerik ekran görüntüsü için JavaScript işlemeyi etkinleştirme. Yalnızca liveCrawl "geri dönüş" olarak ayarlandığında çalışır.
includeImageLinks No boolean yanlış Sayfadan görüntü URL'lerini ekleyin.
language No string "en" Dil kodu (2 harfli ISO 639-1). Tam liste için bkz . Desteklenen Diller .
region No string "US" Bölge kodu (2 harfli ülke/bölge kodu). Tam liste için bkz . Desteklenen Bölgeler .
contentFormat No string "html" Döndürülecek web sayfası içeriğinin biçimi. "text", "html" veya "markdown" olabilir.

İstek Üst Bilgileri

Field Tür Description
host string Microsoft AI API'leri için konak: api.microsoft.ai.
x-apikey veya Yetkilendirme string Kimlik doğrulaması için API anahtarınız veya Entra ID erişim belirteciniz.
içerik türü string İstek gövdesinin MIME türü. application/json adresini kullanın.

Response

Field Tür Description
url string Web sayfasının URL'si.
title string Web sayfasının başlığı.
içerik string Web sayfasının ayıklanan içeriği (yani topraklama).
lastUpdatedAt string Web sayfasının son güncelleştirme tarihi, ISO8601 biçimi izler.
crawledAt string Web sayfasının son gezinme tarihi, ISO8601 biçimi izler.
liveCrawlSucceeded boole (isteğe bağlı) Yalnızca ile başarılı bir istek liveCrawl: "force" eski bir sayfa döndürdüğünde olarak false sunulur. Eski olmayan sayfalar için atlanır; hiçbir zaman olarak truebelirtilmez. , "fallback", atlanmış/null modu için "none"atlanır ve yeniden deneme (202) yanıtları.
traceId string Hata ayıklama için izleme kimliği.
retryAfter string Yeniden denemeden önce bekleme süresi, sonekle "s" saniye cinsinden bir süre olarak biçimlendirilir (örneğin, "60s" 60 saniye bekleme anlamına gelir). Yalnızca isteğe bağlı gezinme devam ederken sunulur.
isAdult boolean Web sayfasının yetişkinlere yönelik içerik içerip içermediğini gösterir.

Note

title, content, isAdult, , lastUpdatedAtve crawledAt alanları yalnızca başarılı (200) yanıtlarda bulunur. Bunlar yeniden deneme (202) yanıtlarından atlanır.

Örneğin, ile "liveCrawl": "force" başarılı bir istek yalnızca eski içerik döndürülürken içerir "liveCrawlSucceeded": false . Eski olmayan bir sayfa, döndürmek trueyerine bu alanı atlar. Bu alan, MCP aracının yapılandırılmış yanıtında aynı anlama sahiptir.

Hata Kodları

Durum Kodu Hata Kategorisi Description Olası Nedenler
200 Success İstek başarılı oldu. -
202 Kabul edildi İstek işlenmek üzere kabul edildi (canlı gezinme). İsteğe bağlı gezinme sürüyor
400 Hatalı İstek Geçersiz istek parametreleri. Eksik gerekli alanlar, geçersiz parametre değerleri, hatalı biçimlendirilmiş JSON
401 Yetkisiz Kimlik doğrulaması başarısız oldu veya eksik. Geçersiz API anahtarı, eksik x-apikey üst bilgisi
403 Yasak Geçerli kimlik bilgileri ancak istek karşılanamıyor. API anahtarında gerekli izinler yok, url ilke tarafından engellendi, içerik filtrelendi
404 Bulunamadı Belge bulunamadı. Geçersiz veya erişilemez URL
410 Gitti HTTPS gereklidir. İSTEK HTTPS yerine HTTP üzerinden yapıldı
415 Desteklenmeyen Medya Türü İçerik türü desteklenmiyor. Eksik veya yanlış içerik türü üst bilgisi
429 Çok Fazla İstek Var Hız sınırı aşıldı. Zaman penceresinde çok fazla istek var
430 Çok Fazla İsteğe Bağlı Gezinme çok fazla isteğe bağlı gezinme. Aşırı canlı gezinme istekleri
500 İç Sunucu Hatası Beklenmeyen sunucu hatası. Geçici sunucu sorunu
503 Hizmet Kullanılamıyor Hizmet geçici olarak kullanılamıyor. Bakım veya geçici kesinti
504 Ağ Geçidi Zaman Aşımı İstek zaman aşımına uğradı. Yukarı akış hizmeti zaman aşımı

Ayrıntılı hata işleme kılavuzu için bkz. Hata İşleme.


Ayrıca bkz:Web Arama | Videoları Arama | Haber Arama | Görüntüleri Arama | MCP