@bitmovin/api-sdk

TypeScript/JavaScript API SDK which enables you to seamlessly integrate the Bitmovin API into your projects.

Using this API client requires an active account.

Don't have an account yet? Sign up for a free Bitmovin trial plan!

Documentation & Release Notes

• Full Bitmovin API reference documentation: https://bitmovin.com/docs/encoding/api-reference
• SDK reference documentation for Javascript: https://bitmovin.github.io/bitmovin-api-sdk-javascript
• Release Notes: https://bitmovin.com/docs/encoding/changelogs/rest

Support

If you have any questions regarding the SDK, provided examples or our services, please log in to your Bitmovin Dashboard at https://bitmovin.com/dashboard and create a support ticket. Our team will get back to you as soon as possible :+1:

Installation

npm install @bitmovin/api-sdk@1.202.0

Initialization

Node

Using ES6 import

import BitmovinApi from '@bitmovin/api-sdk';

const bitmovinApi = new BitmovinApi({apiKey: '<YOUR_API_KEY>'});

With require

exports.__esModule = true;
const BitmovinApi = require('@bitmovin/api-sdk')["default"];

const bitmovinApi = new BitmovinApi({apiKey: '<YOUR_API_KEY>'});

Browser

Use @bitmovin/api-sdk/dist/bitmovin-api-sdk.browser.js or bitmovin-api-sdk.browser.min.js for the minified version.

ES5 with Modules (CommonJS)

Import @bitmovin/api-sdk/dist/index.js.

Types

• Typescript (@bitmovin/api-sdk/dist/index.d.ts)

Examples

You can find sample workflow scripts in the Bitmovin API SDK examples repository.

Deprecated API Client (Legacy)

bitmovin-api-sdk-javascript is the latest Bitmovin API client for TypeScript / JavaScript. It guarantees 100% specification conformity at any given time and access to all features of the API as soon as they are released.

However, if you need to use the previous version for legacy reasons, you can still find it at bitmovin-javascript.