Skip to main content

General usage of Voice Harbor API

Protecting a pre-recorded audio file using the Voice Harbor’s Python SDK

Prerequisite: Ensure that you have Python 3.6+ installed and an active Voice Harbor account with API access.

Step 1: Install Required Libraries

Before you start, you’ll need to install the required libraries for interacting with the Voice Harbor API.

Python SDK

Start using our Python SDK to connect with Voice Harbor and implement voice solutions

From Source

  1. Clone the Voice Harbor SDK repository from Github.
  2. Change into the project directory.
  3. Install the package in editable mode using pip:

Step 2: Set Up Your API Key

To authenticate with the Voice Harbor API, you’ll need to set your API key. Obtain your API key from your Voice Harbor dashboard. To set up the developer token for authentication, use the following code:

Step 3: Set Up the Client and Create a Job

Once you have the necessary setup, you can create a job on the server and interact with the API. Here’s how to do it:

Step 4: Initialize the Client and Submit Job Files

Next, initialize the client and define the parameters for your job, including the files you want to submit for transcription.

Step 5: Submit Job and Download Results

Now, submit the job and wait for the transcription results. Here’s how to complete the process:

Troubleshooting

If you encounter any issues while transcribing the audio, check the following:
  • Ensure that the audio file path is correct and the file is accessible.
  • Check the format of the audio file. Voice Harbor currently supports formats like WAV, MP3, and FLAC.

Additional Resources

For more information, you can refer to the following:

Next Steps

If you’re interested in additional use cases or need help with more advanced features, don’t hesitate to explore our comprehensive Voice Harbor Documentation.