API Documentation Discover

Comparing version 6 and version 5 back

*This resource is depreciated. Use the download resource if possible, or don't use discover XML response.*

URL: http://heywatch.com/discover

h2. Actions


    * [GET] http://heywatch.com/discover : get all discovering task's results
    * [GET] http://heywatch.com/discover/ID : retrieve information about the discovering task
    * [POST] http://heywatch.com/discover : create a discover task

Example response in XML: http://heywatch.com/discover/34.xml [GET]


  34
  ok
  
    
  
  
  http:// youtube.com/watch?v=UxqNsUbWlHc
  Sun Nov 19 02:16:13 CET 2006




h2. Valid parameters for POST


    * **url:** video URL (youtube, myspace, podcast feed, ...), escaped format needed

h3. Optional discover parameters

    * **download:** "true" or "false". If find only one result, download the video automatically. Default is false
    * **title:** title of the video about to be downloaded. Work only if passed download argument (not necessary)
    * **ping_url_after_transfer:** override the global option
    * **ping_url_if_error:** override the global option
    * **custom fields:** if you activate the ping after transfer, you will receive the custom fields in the request

h3. Optional job parameters

    * **automatic_encode:** if "false", the video will not be encoded automatically, even if you set the automatic encode option in your account page.
    * **format_id:** the format ID to use to convert the video. Override the default format option. Work only if you pass automatic_encode=true in the request.
    * **max_length:** length in second. If you don't want your users upload 45min of video
    * All optional parameters from [[API Documentation Job|Job resource]]


If you set the ping urls in your account and decide to not override them in the request, the custom fields will be added at the end of the url to ping.