Sign up for a free account if you haven't already.

Test api.video for free

Use https://sandbox.api.video as your testing endpoint, and use the sandbox key from the dashboard. The sandbox is free and offers unlimited usage. However, it is designed for your testing only, as all videos are watermarked and deleted after 24 hours.

Run in production

Use https://ws.api.video as the endpoint for production, and use your production key from the dashboard.

For detailed instructions on using our API's, visit our tutorials.

Dashboard tour

This section goes over what you'll see in the dashboard when you log in. Sections covered include:

  • Overview
  • Usage
  • Documentation
  • My videos
  • Support
  • Your email (drop-down in upper right of Overview screen)

Your api.video dashboard opens on the Overview screen. Here you can see a list of choices across the top for different sections of the product:

  • Overview - What you see in the picture.
  • Usage - Charts depicting your usage in terms of Transcoding, Hosting, Delivery, and Analytics.
  • Documentation - A link to our docs site (which you're at now!)
  • My Videos - All the videos you've uploaded.
  • Support - Details about api.video status as well as where you can go if you have questions.
  • Email - It's crossed out in the picture, but this will show the email you used to sign up and provides account profile details.

In the center of this screen, you'll six different panels, described here.

Usage

The Usage panel shows you a summary of all your usage information. Details are straightforward:

  • Transcoding - How many minutes of video you transcoded in the system, listed by minute.
  • Hosting - How many minutes of video you are hosting with api.video (based on how many videos you have in your Sandbox and Production areas).
  • Delivery - How many minutes of video you have in your account that you or another user watched.
  • Analytics - api.video offers many analytics through the API, this one shows you how many times all your video content has been played.
  • Your next invoice is -amount- - This section shows you how much money you will owe when your next payment to api.video is due.
  • Details - You can click Details to go to the Usage screen and see more information about how you are using api.video services.

Get started

This section lets you upload videos or do a livestream with no coding. You'll notice two choices:

  • Sandbox - this is all that's available if you don't add credit card details. Adding things to your sandbox is free, but content is watermarked and only lasts for 72 hours.
  • Production - you must enter billing information, then you can place your content here and it will be hosted until you delete it, and it doesn't contain an api.video watermark.
  • Upload - click this button to upload a video to your api.video account with no coding.
  • Livestream - click Start to start the process of creating a livestream.

Sandbox API Key

This section shows you the base URI for all API endpoints for your sandbox key. However, you can use the production API endpoint as well - api.video will be able to detect what key you are using and provide the correct privileges.

The API key is presented in the API Key field. If a problem arises where you think your API key may have been compromised, you can click Regenerate to get a new one.

Production API Key

This section shows you the base URI for all API endpoints for your production key.

The API key is presented in the API Key field. If a problem arises where you think your API key may have been compromised, you can click Regenerate to get a new one.

SDK list

This area shows you all the SDKs currently offered by api.video for consuming its API. If there's a language you'd like to see, please write us in the community forum and let us know. If there are enough requests, or you want to build an SDK yourself we may be able to add it to our collection.

Tutorials

Three popular tutorials are displayed here, but you can click More to see additional documentation options.

Usage

You get to the Usage screen from the Overview screen by clicking Usage at the top of the page or Details in the Usage panel. You will see a section for each of the four usage statistics listed on the front page. Each panel shows 32 days and refreshes every 24 hours to show the latest 32 days.

The way the charts are set up are the same for each one. VOD is any video you've posted that people may want to review. Live is any livestream you are running. The price for each service and how many minutes you've used the service for are listed on each chart. The statistics presented are:

  • Transcoding - How many minutes of video you've transcoded with api.video. VOD and Live are listed.
  • Hosting - Any videos or livestreams of yours that api.video is hosting, showing how many minutes of video are hosted.
  • Delivery - How many minutes of video were watched by you or other users. VOD and Live are listed.
  • Analytics - The total number of times all your content was played. VOD and Live are listed.

Documentation

The Documentation option at the top of the page takes you to the docs site, which you are at now!

My videos

My videos takes you to go.api.video, which provides a GUI interface for managing your videos.

Here you can see all your uploaded videos. If you click the drop-down displaying 'Sandbox' in the upper right, you can toggle to your Production environment. If you play videos in Sandbox, note that it will say 'FOR DEVELOPMENT PURPOSES ONLY' in big letters across each video. Production will remove this message.

At the top of the screen there's a search bar you can use to hunt for videos by title. There's also a drop-down that lets you filter videos by:

  • Created at - when the video was created. You can sort oldest to newest or newest to oldest.
  • Updated at - when the video was last updated. You can sort oldest to newest update or newest to oldest.
  • Title - you can sort ascending, which would be 0-9 and then A-Z, or descending, which would be Z-A and 9-0.

You'll note there are three choices at the top of this screen:

  • Videos - the screen you're on now.
  • Live - just like videos but it shows you all your livestreams instead.
  • Players - a list of the different players you've created for your videos.

Players screen

On the players screen, you can choose to add a new player by clicking the Add player button on the right side of the screen. If you do this you get a screen that lets you customize your new player in a GUI.

Features include:

  • Text color - Any text depicted as part of your player controls will be this color.
  • Link color - Any text that's a link to something and part of your player will be this color.
  • Link hover color - Any text that's a link that you hover your mouse over on your player will be this color.
  • Link active color - Any text that's a link that you click on that's part of your player will be this color.
  • Track played color - As you progress through a video, the part of the track that's already played will be this color.
  • Track unplayed color - As you progress through a video, the part of the track that hasn't played will be this color.
  • Background top color - The background at the top of your player will be this color.
  • Background bottom color - The background at the bottom of your player will be this color.
  • Enable API - Whether you can use api.video API features with your player.
  • Enable controls - Whether your player will offer player controls or not.
  • Force autoplay - Whether your player automatically starts playing the video or livestream when it opens.
  • Hide Title - Whether you want to hide the title of your video in the player or not.
  • Force loop - Whether you want the video to run in a loop when it reaches the
  • Back to list - Exit without saving and go back to the list of videos or livestreams depending on where you came from.
  • Save player - Save your player and you'll be able to associate it with videos and livestreams.

Support

At the top of the my.api.video section, there's a Support button. If you click this you'll see a drop-down with these choices:

  • Status - opens a status screen telling you about the state of api.video's services.
  • Community - this will take you directly to api.video's forum, where you can ask questions and get help from our developer evangelists.
  • [email protected] - you can contact us for help using this email if you want. And you can always click the intercom chat balloon to send us a note.

Status

The Status screen for api.video shows you details about the health of api.video's services.

You can use the Subscribe to Updates button to subscribe to future updates about api.video's system status. The system uses standard color coding for health:

  • Green - healthy
  • Yellow - warning
  • Red - system is down

You cam see the uptime for the following services:

  • Live - Availability of livestream services.
  • Web services - Availability of api.video dashboards, apis, and content.
  • Player - Availability of api.video video player services.
  • VOD - Availability of video on demand services.
  • User space - Availability of user accounts and associated storage.

And you can see a list of past incidents.

Your Email

If you click on your email address in the upper right corner, you get a drop-down with these choices:

  • Information - this will lead you to a page where you can change your password if you like. You will not be able to change your password here if you authenticated using Google. Instead you will get a note saying you can change your password with your actual identity provider.
  • Billing - this will lead you to a page that tells you what you owe by service (Transcoding, Hosting, Delivery, Analytics) and allow you to enter your billing information so you can use your production credentials.

Billing

You can set up credit card information on the Billing screen and see what you owe by api.video service.

Enter your billing details in the Billing information section. You can add a new payment card if you already have one by clicking Payment card and adding your information there.

If you choose to see more details for billing, you will be taken to the Usage screen, which will show you a chart for each api.video service.

You can see past invoices at the bottom of the screen. Invoicing is handled by Stripe. Click the document icon to get a copy of any invoice in your history.