Guides

Getting Started with Verbit

Suggest Edits

Overview

Verbit's APIs provide programmatic access to the platform's comprehensive end-to-end transcription and captioning service.

The seamless integration of transcripts and closed captions for both video and audio into customer systems not only enhances the user experience but also fulfills accessibility requirements. The Verbit APIs offer available features for the following:

  • Insights - The Verbit Insights API or otherwise known as Gen V allows users to use AI to generate content from their caption and transcript assets. This content generation includes things like summaries, keywords, quizzes or even Chapters.
  • Live Booking - The Verbit Live Booking API allows users to provide captioning, translations, and transcription for their live sessions, which can be booked in advance.
  • Search - The Verbit Search API enables the user to build search indexes to enable users to improve and optimize the search of their caption/transcription assets.
  • Caption Control - The Caption Control API provides users with complete control over the captions being generated in Verbit. It allows users to retrieve session information and manage various aspects of the session, including upstream control, caption placement, changing connection plan templates, session duration extension, and ending a session immediately.
  • Post-Production - The Post-production API provides programmatic access to Verbit's premium transcription, captioning, translation and audio description solution.

Please take some time to read through the API reference for more information.

Post-Production vs. Live Booking

As mentioned before, Live booking APIs would be utilized for a live session transcription or Captioning. For example, when a user needs to transcribe a Zoom meeting, the user would book a Live Session. During this session, the audience would be delivered the transcriptions or captions in real-time, and upon completion would be saved to the Verbit platform. The Post-Production API allows the user to take video/audio assets that are already created and process them after they are uploaded to the platform. Take some time to go through the Post-Production and Live Booking API guides.

Profiles

The Verbit platform utilizes profiles to build your captions, transcriptions, and translations which are determined by what was purchased. After the purchase, these profiles are set up by the Verbit team and if the user needs a list of those profiles please refer to the profile API reference.

If the user needs to adjust or add new profiles they will need to reach out the the Verbit team to make any changes.

Authentication

The Verbit API utilizes OAuth 2.0 and requires a bearer token. In order to Authenticate the user needs to be assigned the Admin role in order to generate the JSON web token. Here are the steps:

  1. Generate the API token from the Verbit platform on the my account page.
  2. Then go ahead make the following POST call applying your API key that was generated to the api_key property value: 
curl -X POST "https://users.verbit.co/api/v1/auth"
    -H "Content-Type: application/json"  
    -d '{ "data": { "api_key": "<API-KEY>"} }'

Response:

{
  "token": "eyJraWQiOiJIMVVkZUVXeGJxYjlHY2R5VjB3WFJyVWpzRG5nNUk3aGpwQUFGWHo3eGwwPSI...."
}

The Bearer token expires 24 hours after creation.

This token will be used as your bearer token that will be used in your header when making a call to the API. In the example below we are calling the GET API endpoint to pull a list of profiles. We would apply our bearer token to the authorization property in the header:

curl --request GET \
     --url https://api.verbit.co/api/profiles \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJraWQiOiJIMVVkZUVXeGJxYjlHY2R5VjB3WFJyVWpzRG5nNUk3aGpwQUFGWHo3eGwwPSI....'

The Verbit platform allows users to also authenticate with an API key in the parameters when it comes to Post-Production APIs. Please refer to the Post-Production API guide for more information.

API Usage Examples

Take some time to look through the API call examples. In the links below will walk you through some of the basic usages of all the API endpoints:

Updated 27 days ago