Microsoft Azure VideoDetailSearch API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector VideoDetailSearch API
schemes:
- https
tags:
- name: VideoDetailSearch
paths:
  /videos/details:
    get:
      summary: 'Microsoft Azure The Video Detail Search Api Lets You Search On Bing And Get Back Insights About A Video, Such As Related Videos This Section Provides Technical Details About The Query Parameters And Headers That You Use To Request Insights Of Videos And The Json Response Objects That Contain Them For Examples That Show How To Make Requests, See [searching The Web For Videos] Https: Docs Microsoft Com Azure Cognitive Services Bing Video Search Search The Web'
      operationId: microsoftAzureVideosDetails
      tags:
      - VideoDetailSearch
      parameters:
      - $ref: '#/parameters/x-bingapis-sdk'
      - name: Accept
        in: header
        description: The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/), set the Accept header to application/ld+json.
        required: false
        type: string
      - name: Accept-Language
        x-ms-client-name: AcceptLanguage
        in: header
        description: A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing order of preference. For additional information, including expected format, see [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#setlang) query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#cc) query parameter. To determine the market to return results for, Bing uses the first supported language it finds from the list and combines it with the cc parameter value. If the list does not include a supported language, Bing finds the closest language and market that supports the request or it uses an aggregated or default market for the results. To determine the market that Bing used, see the BingAPIs-Market header. Use this header and the cc query parameter only if you specify multiple languages. Otherwise, use the [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#mkt) and [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#setlang) query parameters. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Any links to Bing.com properties in the response objects apply the specified language.
        required: false
        type: string
      - name: User-Agent
        x-ms-client-name: UserAgent
        in: header
        description: 'The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized experience. Although optional, you are encouraged to always specify this header. The user-agent should be the same string that any commonly used browser sends. For information about user agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of user-agent strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53'
        required: false
        type: string
      - name: X-MSEdge-ClientID
        x-ms-client-name: ClientId
        in: header
        description: 'Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also uses this header to help improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client ID across multiple requests for the same end user and device combination enables 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better quality of results from the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the first time the user uses your app on that device. Use the client ID for each Bing API request that your app makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as mobile apps, use the device''s persistent storage to persist the ID. The next time the user uses your app on that device, get the client ID that you persisted. Bing responses may or may not include this header. If the response includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in the request.'
        required: false
        type: string
      - name: X-MSEdge-ClientIP
        x-ms-client-name: ClientIp
        in: header
        description: The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the location information to determine safe search behavior. Although optional, you are encouraged to always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual location, which may result in Bing serving erroneous results.
        required: false
        type: string
      - name: X-Search-Location
        x-ms-client-name: Location
        in: header
        description: 'A semicolon-delimited list of key/value pairs that describe the client''s geographical location. Bing uses the location information to determine safe search behavior and to return relevant local content. Specify the key/value pair as <key>:<value>. The following are the keys that you use to specify the user''s location. lat (required): The latitude of the client''s location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes. long (required): The longitude of the client''s location, in degrees. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of the coordinates. Pass the value returned by the device''s location service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1, 1970.) head (optional): The client''s relative heading or direction of travel. Specify the direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key. Although many of the keys are optional, the more information that you provide, the more accurate the location results are. Although optional, you are encouraged to always specify the user''s geographical location. Providing the location is especially important if the client''s IP address does not accurately reflect the user''s physical location (for example, if the client uses VPN). For optimal results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should include this header.'
        required: false
        type: string
      - name: cc
        x-ms-client-name: CountryCode
        in: query
        description: A 2-character country code of the country where the results come from. This API supports only the United States market. If you specify this query parameter, it must be set to us. If you set this parameter, you must also specify the Accept-Language header. Bing uses the first supported language it finds from the languages list, and combine that language with the country code that you specify to determine the market to return results for. If the languages list does not include a supported language, Bing finds the closest language and market that supports the request, or it may use an aggregated or default market for the results instead of a specified one. You should use this query parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This parameter and the mkt query parameter are mutually exclusive—do not specify both.
        required: false
        type: string
      - name: id
        x-ms-client-name: Id
        in: query
        description: An ID that uniquely identifies a video. The [Video](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#video) object's videoId field contains the ID that you set this parameter to. You use this parameter to identify the video to get insights of.
        required: false
        type: string
      - name: modules
        x-ms-client-name: Modules
        in: query
        description: 'A comma-delimited list of insights to request. The following are the possible case-insensitive values. All: Return all available insights. RelatedVideos: Return a list of videos that are similar to the video specified by the id query parameter. VideoResult: Return the video that you''re requesting insights of (this is the video that you set the id query parameter to in your insights request). If you specify an insight and there is no data for it, the response object does not include the related field. For example, if you specify RelatedVideos and none exist, the response does not include the relatedVideos field. Although the user''s query term is not required, you should always include it because it helps to improve relevance and the results.'
        required: false
        type: array
        items:
          type: string
          enum:
          - All
          - RelatedVideos
          - VideoResult
          x-ms-enum:
            name: VideoInsightModule
            modelAsString: false
        collectionFormat: csv
      - name: mkt
        x-ms-client-name: Market
        in: query
        description: 'The market where the results come from. Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing delivers results. The market must be in the form <language code>-<country code>. For example, en-US. The string is case insensitive. For a list of possible market values, see [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#market-codes). NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#market-codes), Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#cc) query parameter are mutually exclusive—do not specify both.'
        required: false
        type: string
      - name: q
        x-ms-client-name: Query
        in: query
        description: The user's search query string. The query string cannot be empty. The query string may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit videos to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API.
        required: true
        type: string
      - name: resolution
        x-ms-client-name: Resolution
        in: query
        description: 'Filter videos by the following resolutions: SD480p: Return videos with a 480p or higher resolution. HD720p: Return videos with a 720p or higher resolution. HD1080p: Return videos with a 1080p or higher resolution. All: Do not filter by resolution.Specifying this value is the same as not specifying the resolution parameter.'
        required: false
        type: string
        enum:
        - All
        - SD480p
        - HD720p
        - HD1080p
        x-ms-enum:
          name: VideoResolution
          modelAsString: false
      - name: safeSearch
        x-ms-client-name: SafeSearch
        in: query
        description: 'Filter videos for adult content. The following are the possible filter values. Off: If the request is through the Video Search API, the response includes adult videos and the thumbnail images of the videos are clear (non-fuzzy). If the request is through the Web Search API, the response includes adult videos but the thumbnail images of the videos are pixelated (fuzzy). Moderate: If the request is through the Video Search API, the response does not include videos with adult content. If the request is through the Web Search API, the response may include videos with adult content but the thumbnail images of the videos are pixelated (fuzzy). Strict: Does not return videos with adult content. The default is Moderate. If the request comes from a market that Bing''s adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value and uses Strict. If you use the site: query operator, there is the chance that the response may contain adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are aware of the content on the site and your scenario supports the possibility of adult content.'
        required: false
        type: string
        enum:
        - 'Off'
        - Moderate
        - Strict
        x-ms-enum:
          name: SafeSearch
          modelAsString: false
      - name: setLang
        x-ms-client-name: SetLang
        in: query
        description: The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language code. For example, the language code for English is EN. The default is EN (English). Although optional, you should always specify the language. Typically, you set setLang to the same language specified by mkt unless the user wants the user interface strings displayed in a different language. This parameter and the [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#acceptlanguage) header are mutually exclusive; do not specify both. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Also, any links to Bing.com properties in the response objects apply the specified language.
        required: false
        type: string
      - name: textDecorations
        x-ms-client-name: TextDecorations
        in: query
        description: A Boolean value that determines whether display strings contain decoration markers such as hit highlighting characters. If true, the strings may include markers. The default is false. To specify whether to use Unicode characters or HTML tags as the markers, see the [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#textformat) query parameter. For information about hit highlighting, see [Hit Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).
        required: false
        type: boolean
      - name: textFormat
        x-ms-client-name: TextFormat
        in: query
        description: The type of markers to use for text decorations (see the textDecorations query parameter). Possible values are Raw—Use Unicode characters to mark content that needs special formatting. The Unicode characters are in the range E000 through E019. For example, Bing uses E000 and E001 to mark the beginning and end of query terms for hit highlighting. HTML—Use HTML tags to mark content that needs special formatting. For example, use <b> tags to highlight query terms in display strings. The default is Raw. For display strings that contain escapable HTML characters such as <, >, and &, if textFormat is set to HTML, Bing escapes the characters as appropriate (for example, < is escaped to &lt;).
        required: false
        type: string
        enum:
        - Raw
        - Html
        x-ms-enum:
          name: TextFormat
          modelAsString: false
      responses:
        '200':
          description: Success.
          schema:
            $ref: '#/definitions/VideoDetails'
        default:
          description: An error has occurred. Check the response type and/or status code for more details.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful video detail:
          $ref: ./examples/SuccessfulVideoDetailRequest.json
      description: Needs a more full description created.
definitions:
  ErrorResponse:
    description: The top-level response that represents a failed request.
    allOf:
    - $ref: '#/definitions/Response'
    type: object
    required:
    - errors
    properties:
      errors:
        description: A list of errors that describe the reasons why the request failed.
        type: array
        items:
          $ref: '#/definitions/Error'
  Response:
    description: Defines a response. All schemas that could be returned at the root of a response should inherit from this
    allOf:
    - $ref: '#/definitions/Identifiable'
    type: object
    properties:
      webSearchUrl:
        description: The URL To Bing's search result for this item.
        readOnly: true
        type: string
  MediaObject:
    allOf:
    - $ref: '#/definitions/CreativeWork'
    type: object
    properties:
      contentUrl:
        description: Original URL to retrieve the source (file) for the media object (e.g the source URL for the image).
        readOnly: true
        type: string
      hostPageUrl:
        description: URL of the page that hosts the media object.
        readOnly: true
        type: string
      width:
        description: The width of the source media object, in pixels.
        readOnly: true
        type: integer
        format: int32
      height:
        description: The height of the source media object, in pixels.
        readOnly: true
        type: integer
        format: int32
  Identifiable:
    description: Defines the identity of a resource.
    allOf:
    - $ref: '#/definitions/ResponseBase'
    type: object
    properties:
      id:
        description: A String identifier.
        readOnly: true
        type: string
  CreativeWork:
    allOf:
    - $ref: '#/definitions/Thing'
    type: object
    properties:
      thumbnailUrl:
        description: The URL to a thumbnail of the item.
        readOnly: true
        type: string
      provider:
        description: The source of the creative work.
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/Thing'
      text:
        readOnly: true
        type: string
  ResponseBase:
    discriminator: _type
    type: object
    required:
    - _type
    properties:
      _type:
        type: string
  VideosModule:
    type: object
    properties:
      value:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/VideoObject'
  Thing:
    allOf:
    - $ref: '#/definitions/Response'
    type: object
    properties:
      name:
        description: The name of the thing represented by this object.
        readOnly: true
        type: string
      url:
        description: The URL to get more information about the thing represented by this object.
        readOnly: true
        type: string
      image:
        $ref: '#/definitions/ImageObject'
        readOnly: true
      description:
        description: A short description of the item.
        readOnly: true
        type: string
      alternateName:
        readOnly: true
        type: string
      bingId:
        description: An ID that uniquely identifies this item.
        readOnly: true
        type: string
  ImageObject:
    description: Defines an image
    allOf:
    - $ref: '#/definitions/MediaObject'
    type: object
    properties:
      thumbnail:
        description: The URL to a thumbnail of the image
        $ref: '#/definitions/ImageObject'
        readOnly: true
  VideoObject:
    description: Defines a video object that is relevant to the query.
    allOf:
    - $ref: '#/definitions/MediaObject'
    type: object
    properties:
      motionThumbnailUrl:
        readOnly: true
        type: string
      motionThumbnailId:
        readOnly: true
        type: string
      embedHtml:
        readOnly: true
        type: string
      allowHttpsEmbed:
        readOnly: true
        type: boolean
      viewCount:
        readOnly: true
        type: integer
        format: int32
      thumbnail:
        $ref: '#/definitions/ImageObject'
        readOnly: true
      videoId:
        readOnly: true
        type: string
      allowMobileEmbed:
        readOnly: true
        type: boolean
      isSuperfresh:
        readOnly: true
        type: boolean
  VideoDetails:
    allOf:
    - $ref: '#/definitions/Response'
    type: object
    properties:
      relatedVideos:
        $ref: '#/definitions/VideosModule'
        readOnly: true
      videoResult:
        $ref: '#/definitions/VideoObject'
        readOnly: true
  Error:
    description: Defines the error that occurred.
    type: object
    required:
    - code
    - message
    properties:
      code:
        description: The error code that identifies the category of error.
        type: string
        default: None
        enum:
        - None
        - ServerError
        - InvalidRequest
        - RateLimitExceeded
        - InvalidAuthorization
        - InsufficientAuthorization
        x-ms-enum:
          name: ErrorCode
          modelAsString: false
      subCode:
        description: The error code that further helps to identify the error.
        readOnly: true
        type: string
        enum:
        - UnexpectedError
        - ResourceError
        - NotImplemented
        - ParameterMissing
        - ParameterInvalidValue
        - HttpNotAllowed
        - Blocked
        - AuthorizationMissing
        - AuthorizationRedundancy
        - AuthorizationDisabled
        - AuthorizationExpired
        x-ms-enum:
          name: ErrorSubCode
          modelAsString: false
      message:
        description: A description of the error.
        type: string
      moreDetails:
        description: A description that provides additional information about the error.
        readOnly: true
        type: string
      parameter:
        description: The parameter in the request that caused the error.
        readOnly: true
        type: string
      value:
        description: The parameter's value in the request that was not valid.
        readOnly: true
        type: string
parameters:
  x-bingapis-sdk:
    name: X-BingApis-SDK
    description: Activate swagger compliance
    x-ms-parameter-location: method
    required: true
    type: string
    in: header
    x-ms-enum:
      name: XBingApisSDK
      modelAsString: true
    enum:
    - 'true'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'