How to Create a Vidispine API Instance in Vidinet

By Vidispine - May 17, 2018 (Last updated: September 24, 2019)

It has never been easier to get started with Vidispine API in the cloud. Read this guide to learn how to set up Vidispine API as a service in the Vidinet platform.

If you haven’t signed up for a Vidinet account yet, now is the time. Head over to Vidinet, sign up, and get $300 trial service credits to use. That’s enough for you to get started, run Vidispine API for a few days, and test drive the services.

When done with the registration and you have logged in, there is a menu to the left. Click “Services” and select “Vidispine API Starter Edition”.

This will start the Vidispine API Started Edition launch guide, helping you to set up a new Vidispine API instance including attaching storages and services. In this guide, we will show how to attach file storage, thumbnail storage and creating a new transcoder that can be attached.


The first screen is for setting up the actual API. You set your own display name as well as the API endpoint name. The API endpoint name must be globally unique before you can continue. In this screen, you can also set IP address restrictions for your endpoint, as well as setting API password, and select region to run the instance in. The regions are the same as corresponding AWS regions. The recommendation is to run all services and storage in the same region to minimize egress costs.

API section

This section also allows you to add the new Vidispine API service to a specific service group and select Vidispine version (currently only 4.13.0).

Storage & thumbnails

In the two following sections, you select where your files and thumbnails should be stored. The storage must be on AWS S3 to be able to use in the setup guide, and you have to set it up yourself in your own AWS S3 account before adding it (please head over to the Knowledge base to learn how to configure credentials for your S3 bucket). Make sure to place the buckets in the same region as your Vidispine API and transcoder service. This storage that will automatically be added to your Vidispine API instance during setup. You can add more storage locations later using standard Vidispine API calls.

Vidispine API Setup - Storage section

You can use the same storage for both file storage and thumbnails, or keep them separate. From an API point of view, it makes no difference.


The Vidispine API needs to have a transcoder connected to be able to import files from your storages. You can either use an existing Vidinet transcoder or create a new transcoder during the setup. We recommend that you place the transcoder in the same AWS region as the storage to avoid egress costs.

Vidispine API Setup - Transcoder section

Create a new transcoder using the left side of the screen, or use the drop-down menu on the right side to pick an existing transcoder. You can as always add the transcoder to a specific service group.

Review your setup

In the last step, we ask you to review your set up before you click “Launch”. The launch will take a few minutes, and when the Vidispine API instance is ready we will send you a mail. When the instance is ready you can see it under “My Services” on your Vidinet dashboard. Click on it to expand and see all details regarding your instance, for example, billing, job status and what services you have connected.

Vidispine API Setup - Ready

You can also see the endpoint that can be used directly. I suggest you do a simple call to see that everything works as expected. In this case use

curl -u admin:*******

to get the API version. There is also a link to a web UI for your Vidispine API instance, where you can see items, collections, and jobs directly.

Read more

Read more on how to use the Vidispine API in the Vidispine API Documentation, and read our knowledge base in the Support Portal. Following the blog is a good idea for tips & tricks.

Learn more about Vidinet & Vidispine API as a Service

Contact us to get a demo, or if you just want to have a chat about the Vidinet and Vidispine API as a Service and learn how we can help you.