API Documentation Discover

Comparing version 5 and version 4 back

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=UxqNsUbWlHchttp:// youtube.com/watch?v=UxqNsUbWlHc
  Sun Nov 19 02:16:13 CET 2006




h2. Valid parameters for POST


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

**Optionalh3. parameters:**Optional discover parameters

    * download:**download:** "true" or "false". If find only one result, download the video automatically. Default is false
    * title:**title:** title of the video about to be downloaded. Work only if passed download argument (not necessary)
    * automatic_encode:**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:**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.
    * ping_url_after_transfer:**max_length:** overridelength thein globalsecond. optionIf you don't want your users upload 45min of video
    * ping_url_if_error:All overrideoptional theparameters globalfrom option
    *[[API ping_url_after_encode:Documentation overrideJob|Job the global option, only used if you set the automatic encode option
    * keep_video_size : if "true", will not resize the video at conversion step (ignore width and height values of the selected format)
    * ftp_directive : if automatic_encode is "true", upload the new encoded video to the FTP. Override the global option FTP. Must be: ftp://login:password@host:port/path
    * s3_directive : if automatic_encode is "true", upload the new encoded video to your S3 account. Must be: s3://access_key:secret_key@bucket/object_key. Note that object_key is optional. This parameter will override the global option.
    * custom fields: if you activate the ping after transfer, you will receive the custom fields in the requestresource]]


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.