Rest API-referens för videosökning

Slutpunkt:POST https://api.microsoft.ai/v3/search/videos

Exempelbegäran:

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

Parameter	Required	Type	Default	Description
query	Yes	string	-	En sökfrågesträng. Maximal längd är 1 000 tecken.
maximalt antal resultat	No	integer	30	Maximalt antal resultat som ska returneras. Standardvärdet är 30 och maxvärdet är 30.
language	No	string	"en"	En iso 639-1-språkkod med två bokstäver för gränssnittsspråk i sökresultaten. Se Språk som stöds för den fullständiga listan.
region	No	string	"US"	En lands-/regionkod med två bokstäver för var resultaten ska komma från (t.ex. "US", "JP", "GB" osv.). Se Regioner som stöds för den fullständiga listan.
enablePlaylist	No	boolean	falskt	Om du vill ta med resultat från spellistor som svar.
freshness	No	string	-	Tidsintervallet för att filtrera resultat baserat på identifieringsdatum. Stöder formatet "vecka", "månad", "år" för relativ tid eller ISO 8601 datumintervallformat: "ÅÅÅÅ-MM-DD/ÅÅÅÅ-MM-DD" eller "ÅÅÅÅ-MM-DDTHH:mm:ssZ/ÅÅÅÅ-MM-DDTHH:mm:ssZ" för ett datum-/datumintervall, använd .. för att utelämna start- eller slutdatum.
inbäddningsbar	No	strängmatris	-	Filtrera videor efter inbäddningsfunktioner. Tillåtna värden: "spelare" (har inbäddningsbar spelare). När den inte har angetts tillämpas ingen filtrering.
upplösning	No	string	-	Filtrera videor efter minsta upplösning. Värden: "360p", "480p", "720p", "1080p". När den inte har angetts tillämpas ingen filtrering.
safeSearch	No	string	"strikt"	Nivå av säker sökfiltrering. Värden: "off", "strict". Standardvärdet är "strikt".
duration	No	string	-	Filtrera videor efter varaktighetsintervall. Värden: "short" (<5 min), "medium" (5–20 min), "long" (>20 min). När den inte har angetts tillämpas ingen filtrering.

Rubriker för begäran

Fält	Type	Description
host	string	Värd för Microsoft AI-API:er: api.microsoft.ai.
x-apikey eller auktorisering	string	Din API-nyckel eller Entra ID åtkomsttoken för autentisering.
innehållstyp	string	MIME-typ av begärandetext. Använd application/json.

Svar

Svar på videor

Fält	Type	Description
videoResults	matris med videoResult	Lista över videoresultat.
spellistor	matris med playlistResult (valfritt)	Lista över resultat från spellistor.
instrumentationClickBase	string	Bas-URL för att klicka på ping-begäranden. Lägg till ett instrumentationSuffix värde från ett resultatobjekt för att skapa den fullständiga ping-URL:en. Finns endast för program med profilflaggan EnableInstrumentationPing. Obs! Användarklick kan också loggas med url-omdirigering. När omdirigering har aktiverats krävs ingen åtgärd för att logga användarklickningar och instrumentationClickBase tas inte med i svaret. Se instrumenteringsguiden för installationsinstruktioner.
instrumentationCitationBase	string	Bas-URL för LLM-loggens pingbegäranden. Lägg till en DATA-nyttolast för att skapa den fullständiga ping-URL:en. Finns endast för program med profilflaggan EnableInstrumentationPing.
traceId	string	Spårnings-ID för felsökning.

Note

playlists är ett valfritt fält även när enablePlaylist är inställt på true.

videoResult

Fält	Type	Description
title	string	Videons titel eller namn.
url	string	Videons käll-URL. För Kina-användare med URL-omdirigering aktiverat innehåller det här fältet i stället samma omdirigerings-URL som clickUrl.
domain	string	Målvärden för resultatet. Returneras endast för Kina-användare med URL-omdirigering aktiverat.
description	string	Beskrivning av videoinnehållet. Detta tillhandahålls antingen av videouppladdaren eller genereras av en LLM.
publishedBy	string	Uppladdare eller utgivare av videon.
viewCount	long	Antalet visningar som videon har.
summary	string	AI-genererad videosammanfattning.
length	string	Videons längd i HH:MM:SS-format.
allowHttpsEmbedding	boolean	Om HTTPS-inbäddning tillåts.
allowMobileEmbedding	boolean	Om mobil inbäddning tillåts.
embeddingUrl	string	URL för att bädda in videon.
lastUpdatedAt	string	Det senast uppdaterade datumet som en formaterad sträng.
bestMomentIndex	integer	Indexera det bästa ögonblicket eller markera i videon.
Stunder	matris med ögonblick	Matris med videosegment/ögonblick.
miniatyrbildUrl	string	Videons miniatyr-URL.
width	integer	Videons bredd i bildpunkter.
height	integer	Videons höjd i bildpunkter.
isAdult	boolean	Anger om resultatet innehåller innehåll som är olämpligt för barn.
clickUrl	string	Omdirigerings-URL som proxyservrar klickar genom Bing. Visas endast när klickomdirigering är aktiverat.
instrumentationSuffix	string	Suffix som ska läggas till i instrumentations-ping-URL-basen för det här resultatobjektet. Används som K-värde för både instrumentations-ping-URL:en och clickUrl omdirigeringen. Presentera när instrumentations ping är aktiverat.

Note

Flera av fälten ovan är valfria – de hanteras om de är tillgängliga.

moment

Fält	Type	Description
title	string	Rubrik för ögonblickssegmentet.
description	string	Beskrivning av vad som händer i det här ögonblicket.
startTime	string	Starttid för ögonblicket i formatet "d.hh:mm:ss".
endTime	string	Sluttid för ögonblicket i formatet "d.hh:mm:ss".
momentUrl	string	Dirigera URL:en till det här specifika ögonblicket i videon.

Note

moment är ett valfritt svarsobjekt. Den är inte tillgänglig för varje videoresultat.

playlistResult

Fält	Type	Description
title	string	Spellistans rubrik.
description	string	Beskrivning av spellistan.
videor	matris med video	Matris med videor i spellistan.

Note

playlistResult är ett valfritt svarsobjekt.

video

Fält	Type	Description
title	string	Videons titel.
description	string	Beskrivning av videon.
url	string	URL för videon.

Felkoder

Statuskod	Felkategori	Description	Vanliga orsaker
200	Success	Begäran lyckades.	-
400	Felaktig förfrågan	Ogiltiga parametrar för begäran.	Obligatoriska fält saknas, ogiltiga parametervärden, felaktigt formaterad JSON
401	Behörighet saknas	Autentiseringen misslyckades eller saknas.	Ogiltig API-nyckel, x-apikey-huvud saknas
403	Ej tillåtet	Giltiga autentiseringsuppgifter men otillräckliga behörigheter.	API-nyckeln saknar nödvändiga behörigheter
410	Borta	HTTPS krävs.	Begäran som görs via HTTP i stället för HTTPS
415	Medietyp som inte stöds	Innehållstypen stöds inte.	Rubrik av innehållstyp saknas eller är felaktig
429	För många begäranden	Hastighetsgränsen har överskridits.	För många begäranden i tidsfönstret
500	Internt serverfel	Oväntat serverfel.	Problem med tillfällig server
503	Tjänsten är inte tillgänglig	Tjänsten är inte tillgänglig för tillfället.	Underhåll eller tillfälligt avbrott
504	Tidsgräns för gateway	Tidsgränsen för begäran har överskridits.	Timeout för överordnad tjänst

Detaljerad vägledning för felhantering finns i Felhantering.

---

Se även:Webbsökning | Bläddra bland | nyhetssökningsbilder | Sök MCP |