Getting Started

Clipchamp API – Developer Documentation

Set up and customize your API instance(s), discover and set all configuration options. All parameters are listed on the left. Add those you’d like to use into the script for each embedded button on your site. Note that different buttons can have different parameters set. Some options are only available in our higher plans.

Not an API customer yet? The trial provides access to all API features in the Business plan. Switch to any other plan at any time.

Start free trial

 

Getting started

Step 1

Set up the API through the API setup wizard or manually in your API settings.

After this, copy & paste this line into the <head> section of websites you’ll be embedding Clipchamp buttons on.

<script type="text/javascript" src="https://api.clipchamp.com/Your API key goes here/button.js"></script>

The UI, recording and transcoding module gets loaded as soon as the first button is inserted on a page. You can opt to start loading it at any time by calling the preload function.

<script type="text/javascript"> clipchamp.preload(); </script>

Step 2

Use this code snippet to inject a Clipchamp button into an element of your website. You can embed more than 1 button on a single page and also embed buttons on multiple pages of your website(s).

<!-- add a wrapper element into the document... -->
<script type="text/javascript">
    // ...or dynamically inject at least one wrapper element into the document 
    var element = ...; 
    clipchamp(element[, options]); 
</script>

If you’re using jQuery on your site, the Clipchamp video API is also accessible as a jQuery plugin:

<!-- add a wrapper element into the document... -->
<script type="text/javascript"> 
    // ...or dynamically inject at least one wrapper element into the document 
    $(selector).clipchamp([options]); 
</script>