Video Search API - v7

The Video API lets partners send a search query to Bing and get back a list of relevant videos. Note you should call the Video API if you need video content only. If you need other content such as news and webpages in addition to videos, you must call the Search API which includes videos in the response. You must display the videos in the order provided in the response.

Video Details

Get insights about a video, such as related videos.

Try it

Request URL

Request parameters

string

An ID that uniquely identifies a video. The Video object's videoId field contains the ID that you set this parameter to.

string

A comma-delimited list of one or more insights to request.

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

{
    "_type": "Api.VideoDetails.VideoDetails",
    "instrumentation": {
      "pingUrlBase": "https:\/\/www.bingapis.com\/api\/ping?IG=317000DABF914F1D9D1463841C61BD58&CID=158EB379F1DB6AF32571B869F0856B51&ID=",
      "pageLoadPingUrl": "https:\/\/www.bingapis.com\/api\/ping\/pageload?IG=317000DABF914F1D9D1463841C61BD58&CID=158EB379F1DB6AF32571B869F0856B51&Type=Event.CPT&DATA=0"
    },
    "videoResult": {
      "webSearchUrl": "https:\/\/www.bing.com\/videos\/search?q=&view=detail&mid=F3C1C7A5FCF3EFF15D19F3C1C7A5FCF3EFF15D19",
      "webSearchUrlPingSuffix": "DevEx,5027.1",
      "name": "Lynda Carter slams 'poor soul' James Cameron for 'Wonder Woman' comments",
      "description": "The original actress who played the character calls the comments \"thuggish.\"",
      "thumbnailUrl": "https:\/\/tse3.mm.bing.net\/th?id=OVF.QVfBIDD2fMGxCIruENjEYg&pid=Api",
      "datePublished": "2017-09-29T16:32:28.0000000",
      "publisher": [{
        "name": "ABC News"
      }],
      "creator": {
        "name": "Michael Rothman"
      },
      "contentUrl": "http:\/\/abcnews.go.com\/Entertainment\/lynda-carter-slams-poor-soul-james-cameron-woman\/story?id=50180775",
      "hostPageUrl": "http:\/\/abcnews.go.com\/Entertainment\/lynda-carter-slams-poor-soul-james-cameron-woman\/story?id=50180775",
      "hostPageUrlPingSuffix": "DevEx,5022.1",
      "encodingFormat": "",
      "hostPageDisplayUrl": "abcnews.go.com\/Entertainment\/lynda-carter-slams-poor-soul-james...",
      "width": 992,
      "height": 558,
      "embedHtml": "<iframe src='http:\/\/abcnews.go.com\/video\/embed?id=49498363' width='640' height='360' style='border:none;'><\/iframe>",
      "allowHttpsEmbed": false,
      "thumbnail": {
        "width": 480,
        "height": 270
      },
      "videoId": "F3C1C7A5FCF3EFF15D19F3C1C7A5FCF3EFF15D19",
      "allowMobileEmbed": true,
      "isSuperfresh": true
    }
  }

Code samples

@ECHO OFF

curl -v -X GET "https://api.cognitive.microsoft.com/bing/v7.0/videos/details?id={string}&modules={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["id"] = "{string}";
            queryString["modules"] = "{string}";
            var uri = "https://api.cognitive.microsoft.com/bing/v7.0/videos/details?" + queryString;

            var response = await client.GetAsync(uri);
            if (response?.Content != null)
            {
                var responseString = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseString);    
            }
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import org.apache.http.entity.StringEntity;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.cognitive.microsoft.com/bing/v7.0/videos/details");

            builder.setParameter("id", "{string}");
            builder.setParameter("modules", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "id": "{string}",
            "modules": "{string}",
        };
      
        $.ajax({
            url: "https://api.cognitive.microsoft.com/bing/v7.0/videos/details?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert(JSON.stringify(data));
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.cognitive.microsoft.com/bing/v7.0/videos/details";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"id={string}",
                         @"modules={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.cognitive.microsoft.com/bing/v7.0/videos/details');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'id' => '{string}',
    'modules' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'id': '{string}',
    'modules': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.cognitive.microsoft.com')
    conn.request("GET", "/bing/v7.0/videos/details?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.cognitive.microsoft.com/bing/v7.0/videos/details')
uri.query = URI.encode_www_form({
    # Request parameters
    'id' => '{string}',
    'modules' => '{string}'
})

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body