Automating video production
Narakeet makes it easy to script video production, and integrate it with a continuous delivery pipeline.
For example, you can set up a CI step to deploy your application and take screen-shots of key pages, then use Narakeet to include the latest look and feel of your application into explainer videos automatically.
Another common use-case for Narakeet video automation is to create several versions of a single video, for example in different languages.
Narakeet has a (for now) rudimentary API that lets you produce videos from Narakeet scripts without using the web interface. This page explains the current options for automating video production using the Narakeet API.
We plan to significantly improve automation features in the future, so if none of the options below are good for your workflow, please get in touch by sending an email to firstname.lastname@example.org.
Getting your API key
To use any of the options below, you will need an API key. To request a key, send an email to email@example.com.
How to use the API
- Command-line client
- The easiest way to use the API is with our command-line API client, which runs with Node.js. You can use this command-line tool to request a video build from a local directory, or from an online ZIP archive. See Using the Narakeet Command-line Tool for more information.
- GitHub actions
- For users that want to keep video scripts and assets on GitHub, we support directly building videos using GitHub actions. See Building videos using GitHub actions for more information.
- Using the REST API
- For full control over the process, or if you do not want to install the command-line utility, you can request a video build directly by invoking the API using any REST client, or programming the interactions yourself. See Using the Narakeet REST API for more information.
There is no additional price for using the API, it is included in our regular subscription offer for all commercial users with a personal top-up or pay-as-you-go metered subscriptions.
Flat-fee unmetered accounts or free users are not eligible for API keys.
Scope and API limitations
The API only allows making videos from Markdown scripts. Although users also can convert Powerpoint presentations into videos using Narakeet, it’s not currently possible to directly automate this process.
By default, the API allows you to make 1440 calls per day (1 per minute). If you need to build more videos through the API, request an increased quota by sending an email to firstname.lastname@example.org.