Dashboard tour

Take an in-depth tour of api.video's dashboard! This guide covers everything you'll find there.

📘

Sign-up for an api.video account

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

Sandbox

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 the API, you can browse the tutorials.

Dashboard tour

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

  • Activity
  • Content
  • Resources
api.video Dashboardapi.video Dashboard

api.video Dashboard

In the lefthand menu, you'll find:

  • Activity
  • Content
  • Resources

Activity

The Activity section gives you important details for getting started like your API keys and documentation, and determining how much you've used api.video.

Overview

api.video Overviewapi.video Overview

api.video Overview

The overview section is where you land when you open the api.video dashboard. From here, you can grab and manage your API keys, manually upload a video or start a live stream, and find content for getting started.

Feature

Description

Sandbox/Production toggle button

In the upper right corner of the screen, you'll see a button you can click to toggle between Sandbox and Production. You have a different API key for each, and the videos you create will be slightly different. Sandbox videos are watermarked and only last for 24 hours.
Production videos are hosted until you delete them and don't contain watermarks. To use this feature you must enter billing information.

Get started

This section contains quick links to content you may find useful for getting started.

Upload a video

Click Select Video a video to your api.video account with no coding.

Start a livestream

Click Start Live Stream to start a live stream right the process of creating a live stream.

Usage panel

If you are on the Production setting, you'll see a Usage panel that contains at-a-glance details about your usage and how much your next invoice will be.

API Clients

This area shows you all the clients 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.

Usage

The dashboard to see and follow your usagesThe dashboard to see and follow your usages

The dashboard to see and follow your usages

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 when you are on the Production setting. 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.

Chart

Description

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.

API Keys

This page shows you all available API keys. You can reset your keys here if you feel they were compromised.

The view to access and manage your Sandbox and Production API KeysThe view to access and manage your Sandbox and Production API Keys

The view to access and manage your Sandbox and Production API Keys

Feature

Description

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.

Production API Key

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

Regenerate

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.

Content

The Content panel takes you to where your videos, live streams, and players are stored.

The content panel allows you to upload and manage the videos and live streams from your browserThe content panel allows you to upload and manage the videos and live streams from your browser

The content panel allows you to upload and manage the videos and live streams from your browser

From the landing page, you are presented with a row of choices across the top of the screen:

Feature

Description

api.video Icon

If you click this you return to the landing page for content (which is the same as the Videos page).

Videos

Click this to view your videos and manage them (you start on this page).

Live

Click this to view your live streams and manage them.

Players

Click this to view your players and manage them.

Sandbox/Production toggle button

Click this button toggle between your sandbox/product content. This is available in each section and lets you see what videos, live streams and players you created in each section.

Power button

Click this button to log out of your api.video dashboard.

Videos

Clicking Videos takes you to go.api.video, which provides a GUI interface for managing your videos. Here you can see all your uploaded videos. This is the first view you see when you come from the Content section in your dashboard. 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.

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.

Features

Description

Search bar and magnifying glass icon

At the top of the screen there's a search bar you can use to hunt for videos by title. Enter your search term in the field labeled Search then click the magnifying glass icon to run the search.

Search filter icon

To the right of the magnifying glass is a filter icon. Click the filter icon to open the Tags field. You can then enter tags to search for any videos you've tagged with special terms. Click the filter icon again to hide the Tags field.

Created at drop-down

The Created at drop-down 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.

Upload

Click Upload to upload a new video manually.

Managing Videos

On the Videos screen, you can individually manage videos. Every video has these features:

Features

Description

Checkbox

The upper left corner of every video has a checkbox. If you click this, it will reveal a red trashcan icon at the top of the screen. Click the red trashcan icon to delete any videos that you've placed a checkmark by.

Link icon

Click the link icon on a video to copy the link information for the video.

</> icon

Click the </> icon to grab the code for embedding an iframe of a video.

Video details page

From the Videos screen, you can click on an individual video to view details about it.

The features available on this screen are:

Features

Descriptions

Video playback

You can click the triangle icon on your video to play it.

Video details

Under your video, details are listed. Information includes whether the video is public or private, when it was created, when it was updated, how many people viewed it, and any tags or metadata you included about your video.

Iframe Copy code

If you click Copy code under the iframe embed code, you can immediately copy the code for use in your projects.

Embed Copy link

If you click Copy link under the embed link for your video, you can copy the link that lets you embed your video.

Copy mp4 link

If you click Copy mp4 link you can grab the link that gives you a downloadable mp4 of your video. This is only available if you choose mp4 support for your video.

Edit video

Click Edit video to go to a screen that lets you edit basic information about your video.

Captions

Click Captions to go to a screen that lets you review and manage captions for your video.

Delete video

Click Delete video to delete your video. Deletion is permanent.

Thumbnail

Click Thumbnail to go to a screen that lets you manage the thumbnail for your video.

Chapters

Click Chapters to go to a screen that lets you manage chapters for your video.

Download

Click Download to get an mp4 of your video.

Edit a video

On the Edit a video screen, you can update the metadata for your video manually.

The features for this screen include:

Feature

Description

Title

Enter the title of your video in the field.

Description

You can provide a brief description of your video here.

Panoramic

Toggle the checkbox on if your video is panoramic, or off if it is not.

MP4 support

Toggle the checkbox on if you want people to be able to download an MP4 of your video, or off if not.

Player id

If you want to associate an api.video player with your video, you can enter the player ID for it here. Use the drop-down to choose from your players.

Tags

If there are any words or phrases you wanted to tag your video with for searching, you can put them here. Click the X on a tag to delete it.

Metadata

You can add key value pairs for metadata. This allows you to reuse keys for different sets of information. Click the red trash can icon if you want to delete a pair. You can also edit pairs.

Back to list

Click Back to list to return to the list of all your videos.

Save video

Click Save video to save your changes. If you don't do this, your changes will not be maintained.

Captions

The captions screen lets you see what captions you've set up for your video, as well as add new ones.

The first page displays closed captioning you've added for your video.

Feature

Description

Back to video

Click Back to video to go back to the main page for your video.

Add caption

Click Add caption to add a new caption.

Set default

For a caption listed, you can click Set default to make it the first caption to be displayed. (Users can switch to other captions in a preferred language if you have those available.)

Delete

Click Delete to permanently remove a caption from the list.

Add a caption screen

The Add a caption screen lets you upload a caption for your video.

Feature

Description

Language

Enter a language for your caption. You'll need to use a valid BCP 47 language representation.

File

Your caption file must be a .vtt file. You can upload it by clicking Browse and choosing the file you want to use.

Back to list

This returns you to the list of captions for your video.

Save caption

This saves the caption you added.

Thumbnail

You can manage the thumbnail for your video, or set it with the Thumbnail screen.

The features for the Thumbnail screen are:

Feature

Description

Thumbnail type

Choose Timecode to select a single frame from your video by timecode for use as the thumbnail, or upload an image (JPG only) that you want to act as the thumbnail.

Back to view

Click Back to view to go back to your video.

Save thumbnail

Click Save thumbnail to save the changes you made to your video thumbnail.

Chapters

The Chapters section lets you add chapters to your video using a .VTT file.

The features for this page include:

Feature

Description

Back to video

Click Back to video to go back to your video.

Add chapters

Click Add chapters to go to the Add chapters screen and create chapters for your video.

Delete

You can delete chapter files you've added. You can have a different file for each language. To delete a file, click Delete.

Add chapters screen

You can add chapters on this screen as long as they are in .VTT format.

Features on the Add chapters screen include:

Feature

Description

Language

Add a valid BCP 147 representation of a language tag here to represent the language your chapters are in.

File (.vtt)

You can upload a .vtt file to add chapters to your video. Click Browse to choose the file.

Back to list

Click Back to list to go back to the list of chapters you have.

Save chapters

Click Save chapters to save the chapters .VTT file you add.

Live

Create and manage all your live streams from the Live page.

On this page you can see your live streams. You can also click a live stream for more information. If you do that, you'll get a page like this:

You can review and edit some details of your live stream. You are not able to delete it here - for that you must use the API.

Feature

Description

Live stream

If you're running a live stream, you can click the play icon in the middle of your video to get it running and test it out here.

Stream key

This is your stream key, you can retrieve this for your code and no-code projects. Click Copy to use it.

RTMP Server Url

This is your RTMP server URL. You'll need it for your encoder. OBS requires this for configuration, as do many live streaming platforms.

RTMP Stream Url

This is your RTMP stream URL. You'll need it when you're streaming straight to the browser with something like FFMPEG.

Copy code

Click this to copy the code for embedding an iframe of your live stream in an HTML page.

Copy link

Click this to copy the link for your live stream. You can put this in a browser and go straight to the stream.

Enable recording

Slide the button to the right to record your live stream. It will appear in the Videos section when it completes.

Edit

Click Edit to go to a page that lets you review and manage some details for your live stream.

Thumbnail

Click Thumbnail to go to a page that lets you upload a JPG to act as a thumbnail for your live stream.

Edit a live stream

You can change the name of your live stream on the Edit a live stream page. If you want to delete an existing live stream, you must do so through the API.

Features on this page include:

Feature

Description

Name

Enter the name of the live stream. You can change it using this field.

Back to list

Click Back to list to go back to all available live streams.

Save live stream

Click Save live stream to save your changes.

Players

In this section, you can find a list of the different players you've created for your videos.

Feature

Description

Add player

Click Add player to add a new player and configure it.

Player actions

Click Edit to go to the Edit a player screen. You can configure player settings there. Click Delete to permanently delete your player.

Logo actions

Click Edit to go to the Edit player logo screen. Click Delete to remove the logo you added to your player.

Edit a player screen.

This screen allows you to configure details about your player.

Features include:

Feature

Description

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

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.

Edit player logo screen

This screen allows you to add and manage a logo you want for your player.

Features include:

Feature

Description

Logo

Click Browse to search for a logo for your player. Logos may be up to 100px tall and either a JPG or PNG.

Logo link

You can add a link for your logo here.

Back to list

Click Back to list to go back to your list of players.

Save logo

Click Save logo to save your work.

Resources

Documentation

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

API Clients

This area shows you all the SDKs currently offered by api.video for consuming its API.

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.

Community Forum

Community (https://community.api.video/) - this will take you directly to api.video's forum, where you can ask questions and get help from our developer evangelists.

Help

  • [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.

Create a Production account

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.


Did this page help you?