Skip to content
TypeScript/JavaScript API SDK which enables you to seamlessly integrate the Bitmovin API into your projects
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples
src
.gitignore
.prettierrc
LICENSE
README.md
jest.config.js
package.json
tsconfig.json
tslint.json
webpack.config.js

README.md

Bitmovin TypeScript/JavaScript API SDK Header

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

npm version License

Using this API client requires an active account.

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

For full documentation of all available API endpoints, see the Bitmovin API reference.

Installation


npm install @bitmovin/api-sdk@1.29.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.

Previous 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.

You can’t perform that action at this time.