Transcription Client Command Line Interface Guide

Adding otcli.exe to PATH

Important: Before using the CLI, you need to add the 360converter Offline Transcriber installation directory to your system's PATH environment variable. This allows you to run otcli.exe from any location in the command prompt.

How to Add otcli.exe to PATH:

  1. Right-click on "This PC" or "My Computer" and select "Properties".
  2. Click on "Advanced system settings" on the left side.
  3. Click the "Environment Variables" button.
  4. Under "System variables", find and select the "Path" variable, then click "Edit".
  5. Click "New" and add the full path to the directory containing otcli.exe (e.g., C:\Program Files\360converter Offline Transcriber).
  6. Click "OK" to close all dialogs.
  7. Restart any open command prompt windows for the changes to take effect.

After adding otcli.exe to your PATH, you can run it from any location without specifying the full path.

Introduction

The Transcription Client Command Line Interface (CLI) is a powerful tool designed to interact with our transcription service. It allows users to send transcription jobs, monitor their status, and retrieve results efficiently. This guide will walk you through the various functionalities and provide examples of how to use the CLI effectively.

Key Features

  • Send transcription jobs with various options
  • Specify source and target languages
  • Define time ranges for transcription
  • Add prompts to guide transcription
  • Check job status
  • Retrieve transcripts in different formats
  • Get list of supported languages
  • Run an AI template (meeting minutes, action items, your own) after transcription

Basic Usage

The basic syntax for using the Transcription Client CLI is:

otcli.exe --action <action> [options]

Where <action> is either "send" or "get", followed by various options depending on the action.

Use Cases

1. Basic Transcription Job

otcli.exe --action send --source "E:\audioForTesting\example.mp3"

This command sends a basic transcription job for the specified audio file using default settings.

2. Transcription with Specific Language

otcli.exe --action send --source "E:\audioForTesting\example.mp3" --language "es"

This command specifies that the audio is in Spanish (es).

3. Transcription with Translation to English

otcli.exe --action send --source "E:\audioForTesting\example.mp3" --language "fr" --target-language "English"

This command transcribes French audio and translates the result to English.

4. Transcription with Time Range

otcli.exe --action send --source "E:\audioForTesting\example.mp3" --start-time 30 --end-time 90

This command transcribes only the portion of the audio from 30 seconds to 90 seconds.

5. Transcription with Prompt

otcli.exe --action send --source "E:\audioForTesting\example.mp3" --prompt "This is a lecture about climate change"

This command includes a prompt to guide the transcription process.

6. Comprehensive Transcription Job

otcli.exe --action send --source "E:\audioForTesting\example.mp3" --language "de" --target-language "English" --start-time 60 --end-time 180 --prompt "This is a German podcast about renewable energy"

This command combines multiple options: it specifies German as the source language, requests translation to English, sets a time range from 60 to 180 seconds, and includes a prompt.

7. Get Job Status

otcli.exe --action get --get-type status --jobid JOB_ID_HERE

Replace JOB_ID_HERE with the actual job ID returned when you sent the job.

8. Get Transcript (Text Format)

otcli.exe --action get --get-type transcript --jobid JOB_ID_HERE --format txt

This command retrieves the transcript in plain text format.

9. Get Transcript (JSON Format) with Timestamps

otcli.exe --action get --get-type transcript --jobid JOB_ID_HERE --format json --timestamp

This command retrieves the transcript in JSON format, including timestamp information for each segment.

10. Get Supported Languages

otcli.exe --action get --get-type languages

This command fetches and displays the list of languages supported by the transcription service.

11. Get Subtitles, Markdown, HTML or CSV

otcli.exe --action get --get-type transcript --jobid JOB_ID_HERE --format vtt
otcli.exe --action get --get-type transcript --jobid JOB_ID_HERE --format md > meeting.md

--format accepts txt (default), json, srt, vtt, md, html and csv. For Markdown, HTML and CSV, otcli prints the document itself, so you can redirect it into a file. See Export Transcripts and Subtitles.

12. List AI Templates

otcli.exe --action get --get-type templates --verbose

Prints the name of each AI template; with --verbose also its mode and whether it is built in. Templates you create in the app are included.

13. Transcribe and Run an AI Template

otcli.exe --action send --source "E:\audioForTesting\meeting.mp3" --ai-template "Meeting minutes" --ai-language en

After transcription, the server runs the template. --ai-language is optional (an AI language code such as en, fr or zh-CN) and needs --ai-template. See AI Output Templates.

14. Get the AI Template Output

otcli.exe --action get --get-type ai-output --jobid JOB_ID_HERE

Prints the AI output. Add --verbose to see the template name and the AI status (pending, completed or failed).

Additional Options

  • --verbose: Add this flag to any command for more detailed output.
  • --help: Display the help message with all available options.

Note: Remember to replace JOB_ID_HERE with the actual job ID in the "get" commands. The job ID is provided in the output when you send a transcription job.

Transcription Client

For more details on how to interact with these endpoints, please refer to the Transcription Client documentation.