====== Public Videos API ======

===== How to build the URL =====
==== GET calls ====

<nowiki>http://</nowiki>{publicvideos_api_node}/v/{version}/{resource}

  * publicvideos_api_node: Just replace it with **api.publicvideos.org** for now :)
  * version: the version of the API to be used. Replace it with **0** for now since there is only one version of the API (version 0).
  * resource: one of the available entrypoints for the API version you are using. Example **clips/total**

==== Example ====
<code>
curl http://api.publicvideos.org/v/0/clip/2184
</code>

==== POST, PUT, DELETE calls ====

Not implemented yet.

===== Glossary =====
  = Clip: Scene captured on video.
  = Set: Collection of clips.
  = Author: Person who shots clips.
  = Version: Digital file representing a clip.
  = Transcoder: Agent that given a clip generates a version.
  = Transcoding Step: A command executed by a transcoder.


===== Current version: 0, status:under development =====
==== Resources ====
=== Objects ===

  * [[.:v0:clip|/clip]]
  * [[.:v0:set|/set]]
  * [[.:v0:author|/author]]
  * [[.:v0:version|/version]]
  * [[.:v0:transcoder|/transcoder]]
  * [[.:v0:transcoding_step|/transcoding_step]]

=== Lists ===

  * [[.:v0:clips|/clips]]
  * [[.:v0:sets|/sets]]
  * [[.:v0:authors|/authors]]
  * [[.:v0:versions|/versions]]
  * [[.:v0:transcoders|/transcoders]]
  * [[.:v0:transcoding_steps|/transcoding_steps]]

=== Filtered Lists ===

  * [[.:v0:clips:author:author|/clips/author/{author}]]
  * [[.:v0:clips:set:set|/clips/set/{set}]]
  * [[.:v0:sets:author:author|/sets/author/{author}]]
  * [[.:v0:versions:clip:clip|/versions/clip/{clip}]]
  * [[.:v0:versions:transcoder:transcoder|/versions/transcoder/{transcoder}]]
  * [[.:v0:versions:transcoder:transcoder:author:author|/versions/transcoder/{transcoder}/author/{author}]]
  * [[.:v0:versions:transcoder:transcoder:set:set|/versions/transcoder/{transcoder}/set/{set}]]
  * [[.:v0:transcoding_steps:transcoder:transcoder|/transcoding_steps/transcoder/{transcoder}]]