Video Arama REST API başvurusu

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

Örnek İstek:

curl -X POST "https://api.microsoft.ai/v3/search/videos" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "cute puppy videos",
    "maxResults": 30,
    "language": "en",
    "region": "US"
  }'

Parameters

Parametre	Required	Tür	Default	Description
query	Yes	string	-	Arama sorgusu dizesi. Uzunluk üst sınırı 1000 karakterdir.
maxResults	No	integer	30	Döndürülecek en fazla sonuç sayısı. Varsayılan değer 30, maksimum değer ise 30'dur.
language	No	string	"en"	Arama sonuçlarında arabirim dili için 2 harfli ISO 639-1 dil kodu. Tam liste için bkz . Desteklenen Diller .
region	No	string	"US"	Sonuçların nereden gelmesi gerektiği için 2 harfli ülke/bölge kodu (ör. "ABD", "JP", "GB", vb.). Tam liste için bkz . Desteklenen Bölgeler .
enablePlaylist	No	boolean	yanlış	Çalma listesi sonuçlarının yanıt olarak eklenip eklenmeyeceği.
freshness	No	string	-	Bulma tarihine göre sonuçları filtrelemek için zaman aralığı. Göreli saat için "week", "month", "year" veya ISO 8601 tarih aralığı biçimini destekler: "YYYY-AA-GG/YYYY-AA-GG" veya "YYYY-AA-GGTHH:mm:ssZ/YYYY-AA-DDTHH:mm:ssZ" tarih/tarih saat aralığı için kullanın... başlangıç veya bitiş tarihini atlar.
eklenebilir	No	dize dizisi	-	Özellikleri ekleyerek videoları filtreleyin. İzin verilen değerler: "player" (eklenebilir oynatıcıya sahiptir). Ayarlanmadığında, filtreleme uygulanmaz.
çözünürlük	No	string	-	Videoları minimum çözünürlüğe göre filtreleyin. Değerler: "360p", "480p", "720p", "1080p". Ayarlanmadığında, filtreleme uygulanmaz.
safeSearch	No	string	"katı"	Güvenli arama filtreleme düzeyi. Değerler: "off", "strict". Varsayılan değer "katı"dır.
duration	No	string	-	Videoları süre aralığına göre filtreleyin. Değerler: "short" (<5 dk), "medium" (5-20 dk), "long" (>20 dk). Ayarlanmadığında, filtreleme uygulanmaz.

İ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

Videolar Yanıtı

Field	Tür	Description
videoResults	videoResult dizisi	Video sonuçlarının listesi.
çalma listeleri	playlistResult dizisi (isteğe bağlı)	Çalma listesi sonuçlarının listesi.
instrumentationClickBase	string	Tıklama ping istekleri için temel URL. instrumentationSuffix Tam ping URL'sini oluşturmak için sonuç öğesinden bir değer ekleyin. Yalnızca EnableInstrumentationPing profil bayrağına sahip uygulamalar için sunulur. Not: Kullanıcı tıklamaları URL yeniden yönlendirmesi kullanılarak da günlüğe kaydedilebilir. Yeniden yönlendirme etkinleştirildiğinde, Kullanıcı tıklamalarını günlüğe kaydetmek için hiçbir eylem gerekmez ve instrumentationClickBase yanıta dahil edilmeyecektir. Kurulum yönergeleri için İzleme kılavuzuna bakın.
instrumentationCitationBase	string	LLM günlük ping istekleri için temel URL. Tam ping URL'sini oluşturmak için bir VERİ yükü ekleyin. Yalnızca EnableInstrumentationPing profil bayrağına sahip uygulamalar için sunulur.
traceId	string	Hata ayıklama için izleme kimliği.

Note

playlists , true olarak ayarlandığında bile enablePlaylist isteğe bağlı bir alandır.

videoResult

Field	Tür	Description
title	string	Videonun başlığı veya adı.
url	string	Videonun kaynak URL'si. URL yeniden yönlendirmesi etkinleştirilmiş Çin kullanıcıları için, bu alan bunun yerine ile aynı yeniden yönlendirme URL'sini clickUrliçerir.
domain	string	Sonucun hedef ana bilgisayarı. Yalnızca URL yeniden yönlendirmesi etkinleştirilmiş Çin kullanıcıları için döndürülür.
description	string	Video içeriğinin açıklaması. Bu, video yükleyicisi tarafından sağlanır veya bir LLM tarafından oluşturulur.
publishedBy	string	Videoyu karşıya yükleyen veya yayımlayan.
viewCount	long	Videonun görüntüleme sayısı.
summary	string	Yapay zeka tarafından oluşturulan video özeti.
length	string	Videonun HH:MM:SS biçimindeki uzunluğu.
allowHttpsEmbedding	boolean	HTTPS eklemeye izin verilip verilmeyeceği.
allowMobileEmbedding	boolean	Mobil eklemeye izin verilip verilmeyeceği.
embeddingUrl	string	Videoyu eklemek için URL.
lastUpdatedAt	string	Biçimlendirilmiş dize olarak son güncelleştirme tarihi.
bestMomentIndex	integer	Videodaki en iyi anın veya vurgunun dizini.
anları	moment dizisi	Video segmentleri/an dizisi.
küçükResimURL	string	Videonun küçük resim URL'si.
width	integer	Videonun piksel cinsinden genişliği.
height	integer	Videonun piksel cinsinden yüksekliği.
isAdult	boolean	Sonucun yetişkinlere yönelik içerik içerip içermediğini gösterir.
clickUrl	string	Tıklamayı Bing'e yönlendiren URL'yi yeniden yönlendirin. Yalnızca tıklama yeniden yönlendirme etkinleştirildiğinde bulunur.
instrumentationSuffix	string	Bu sonuç öğesi için izleme ping URL'si tabanına eklenecek son ek. Hem izleme ping URL'si clickUrl hem de yeniden yönlendirme için K değeri olarak kullanılır. İzleme ping'i etkinleştirildiğinde bulunur.

Note

Yukarıdaki alanların bazıları isteğe bağlıdır; kullanılabilir durumdaysa bunlar sunulur.

an

Field	Tür	Description
title	string	Moment segmentinin başlığı.
description	string	Bu anda ne olacağının açıklaması.
startTime	string	'd.hh:mm:ss' biçimindeki o anın başlangıç saati.
endTime	string	'd.hh:mm:ss' biçimindeki anın bitiş saati.
momentUrl	string	Url'yi videodaki bu ana yönlendirin.

Note

moment isteğe bağlı bir yanıt nesnesidir. Her video sonucu için kullanılamaz.

playlistResult

Field	Tür	Description
title	string	Çalma listesinin başlığı.
description	string	Çalma listesinin açıklaması.
videolar	video dizisi	Çalma listesindeki video dizisi.

Note

playlistResult isteğe bağlı bir yanıt nesnesidir.

video

Field	Tür	Description
title	string	Videonun başlığı.
description	string	Videonun açıklaması.
url	string	Videonun URL'si.

Hata Kodları

Durum Kodu	Hata Kategorisi	Description	Olası Nedenler
200	Success	İstek başarılı oldu.	-
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 izinler yetersiz.	API anahtarında gerekli izinler yok
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
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 Araması | Gözat | Haber Arama | Görüntüleri Arama | MCP