Entity Recognition API 1.1

Various VideoSurf APIs rely the use of entity ids to represent various people and topics in our system. Use this service to look up specific entities via their names.

URL

• The URL where you can access this API looks like:
  http://apis.videosurf.com/entity_recognition/v1.1/?query=Britney%20Spears

Authentication

• Each use of any VideoSurf API is subject to the Terms Of Use and requires you to provide a valid client_id and client_key
• client_id - A human readable client identifier. Please pick something short and descriptive.
  • Required
  • Type: String
  • Example: client_id=your_domain
• client_key - This is an authorization token issued to you by VideoSurf. Obtain one here.
  • Required
  • Type: String
  • Example: client_key=900d77b8e40e60f0113dccc2973f2ed1

Inputs

• query - A comma-separated list of url encoded strings to match against. Up to 10 strings can be looked up at once.
  • Required
  • Type: String
  • Example: query=Britney+Spears,Will+Smith,30+Rock
• count - The number of matches to return per query.
  • Optional
  • Type: Number
  • Default: 1
  • Maximum: 5
  • Example: count=2
• callback - An optional callback function to wrap the response. This is useful for client side scripting with a technique called JSONP. This will only be utilized if the output_format is json.
  • Optional
  • Type: String
  • Example: callback=my_fn - This will result in a response that looks like this: my_fn({ json goes here });
• output_format - Format of the response, either as a JSON object or serialized PHP.
  • Optional
  • Type: String
  • Default: json
  • Possible Values:

    json	JSON object (more info on json)
    php	Serialized PHP (more info on serialized php)

  • Example: output_format=php

Output

• entities - A dictionary mapping each input query to a dictionary of matching entities
  • Input Query - Maps to an array of matches for this input query, each containing:
    • entity_id - A numeric identifier for the matching entity
    • entity_name - The title of this entity
    • score - A numeric score assigned to each match. The higher the score, the more confident the match.