Skip to content

External access to the Transcript Editor

Introduction

In the following sections, you will find information about the integration of the Transcript Editor into your workflow or third-party application.

You can generate a URL to let your users access the Transcript Editor without the need to log in to the DeepVA platform. This enables certain use cases where you want to provide a seamless integration of the Transcript Editor into your application.

The Transcript Editor can be embedded into your web-based application or accessed via a direct link (deep linking).

Transcript Editor

Authentication

You can authorize users to access the Transcript Editor by generating a JWT token with the necessary scopes. The JWT token is used to authenticate the user and to grant access to the Transcript Editor.

A secret is required to encode the JWT token. The secret is part of the Access Key that you can create via the DeepVA API. Never share the secret with someone.

You have to generate an Access Key with the following scopes:

  • transcript.read
  • transcript.write
  • export.read
  • export.write

Here is an example to encode a JWT token based on the secret of an Access Key

import jwt
secret = "PUT YOUR SECRET FROM YOUR ACCESS KEY HERE"
jwt_token = jwt.encode({}, secret, algorithm='HS256')
print(jwt_token)

The JWT token is provided as a query parameter in the URL to access the Transcript Editor.

Accessing the Transcript Editor

Use the following URL to access the Transcript Editor:

https://api.deepva.com/transcript-editor?transcript_id=<TRANSCRIPT_ID>&token=<ACCESS_KEY.KEY>.<JWT_TOKEN>

The token is a combination of the access key public key field and the JWT token. The access key is the key of the Access Key and the JWT token is the encoded token based on the secret of the Access Key.

Replace <TRANSCRIPT_ID> with the ID of the transcript you want to edit. The <TRANSCRIPT_ID> can be obtained by the Transcript resource.

An optional query parameter video_source can be added to the URL to override the video source for the transcript.

https://api.deepva.com/transcript-editor?transcript_id=<TRANSCRIPT_ID>&video_source=<PUBLIC_URL_TO_VIDEO>&token=<ACCESS_KEY.KEY>.<JWT_TOKEN>