Skip to content

cielo24/respeecher-python

BranchesTags

Repository files navigation

respeecher

API for interacting with Respeecher services, including key and session management, and calibration functionalities.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import respeecher

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import respeecher

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import respeecher
from respeecher.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
name = 'name_example' # str | 
data = 'data_example' # str | 

try:
    # Create a new Calibration
    api_response = api_instance.create_calibration(name, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->create_calibration: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.FolderRequest() # FolderRequest | 

try:
    # Create a folder
    api_response = api_instance.create_folder(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->create_folder: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.NoteRequest() # NoteRequest | 

try:
    # Create a note associated with a recording
    api_response = api_instance.create_note(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->create_note: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.OrderRequest() # OrderRequest | 

try:
    # Create a conversion order
    api_response = api_instance.create_order(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->create_order: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
data = 'data_example' # str | 
parent_folder_id = 'parent_folder_id_example' # str | 
microphone = 'microphone_example' # str | 
label = 'label_example' # str | 

try:
    # Create an original recording
    api_response = api_instance.create_original_recording(data, parent_folder_id, microphone, label)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->create_original_recording: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.ProjectRequest() # ProjectRequest | 

try:
    # Create a new project
    api_response = api_instance.create_project(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->create_project: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.TTSRecordingRequest() # TTSRecordingRequest | 

try:
    # Create an original text-to-speech recording
    api_response = api_instance.create_tts_recording(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->create_tts_recording: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))

try:
    # Delete the API key associated with your account
    api_instance.delete_api_key()
except ApiException as e:
    print("Exception when calling DefaultApi->delete_api_key: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
calibration_id = 'calibration_id_example' # str | 

try:
    # Delete a calibration
    api_response = api_instance.delete_calibration(calibration_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_calibration: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
folder_id = 'folder_id_example' # str | 

try:
    # Delete a folder
    api_response = api_instance.delete_folder(folder_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_folder: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.NoteDeleteRequest() # NoteDeleteRequest | 

try:
    # Delete a note
    api_response = api_instance.delete_note(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_note: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
project_id = 'project_id_example' # str | 

try:
    # Delete a project
    api_response = api_instance.delete_project(project_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_project: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
recording_id = 'recording_id_example' # str | The ID of the recording to delete

try:
    # Delete a recording
    api_instance.delete_recording(recording_id)
except ApiException as e:
    print("Exception when calling DefaultApi->delete_recording: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
calibration_id = 'calibration_id_example' # str | 

try:
    # Set a calibration as the default enabled calibration
    api_response = api_instance.enable_calibration(calibration_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->enable_calibration: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
project_id = 'project_id_example' # str | 
starred_only = true # bool |  (optional)

try:
    # Export a project
    api_response = api_instance.export_project(project_id, starred_only=starred_only)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->export_project: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.FavoriteVoiceIdBody() # FavoriteVoiceIdBody | 
voice_id = 'voice_id_example' # str | 

try:
    # Mark a voice as a favorite
    api_response = api_instance.favorite_voice(body, voice_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->favorite_voice: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.ApiApikeyBody() # ApiApikeyBody | 

try:
    # Generate a new API key
    api_response = api_instance.generate_api_key(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->generate_api_key: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
accent_id = 'accent_id_example' # str | 

try:
    # Get samples available for an accent
    api_response = api_instance.get_accent_samples(accent_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_accent_samples: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))

try:
    # Get the statistics for your account
    api_response = api_instance.get_account_statistics()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_account_statistics: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
calibration_id = 'calibration_id_example' # str | 

try:
    # Get a calibration by its ID
    api_response = api_instance.get_calibration(calibration_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_calibration: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))

try:
    # Get the credits available to your account
    api_response = api_instance.get_credits()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_credits: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
folder_id = 'folder_id_example' # str | 

try:
    # Get a folder by its ID
    api_response = api_instance.get_folder_by_id(folder_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_folder_by_id: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.FoldersStatisticsRequest() # FoldersStatisticsRequest | 

try:
    # Get statistics for a list of folders
    api_response = api_instance.get_folders_statistics(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_folders_statistics: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
project_url = 'project_url_example' # str | 

try:
    # Get a project by its URL
    api_response = api_instance.get_project_by_url(project_url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_project_by_url: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
project_ids = 'project_ids_example' # str | Comma-separated list of project IDs to fetch statistics for. (optional)

try:
    # Get statistics for a list of projects
    api_response = api_instance.get_projects_statistics(project_ids=project_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_projects_statistics: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
recording_id = 'recording_id_example' # str | The ID of the recording to fetch

try:
    # Get a recording by its ID
    api_response = api_instance.get_recording_by_id(recording_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_recording_by_id: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))

try:
    # Get a list of calibrations associated with your account
    api_response = api_instance.list_calibrations()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->list_calibrations: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
original_id = 'original_id_example' # str | 
limit = 56 # int |  (optional)
offset = 56 # int |  (optional)
direction = 'direction_example' # str |  (optional)

try:
    # Get a list of the conversions for an original recording
    api_response = api_instance.list_conversions(original_id, limit=limit, offset=offset, direction=direction)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->list_conversions: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
project_id = 'project_id_example' # str | 
limit = 56 # int |  (optional)
offset = 56 # int |  (optional)
direction = 'direction_example' # str |  (optional)

try:
    # Get a list of the folders in a project
    api_response = api_instance.list_folders(project_id, limit=limit, offset=offset, direction=direction)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->list_folders: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))

try:
    # Get a list of the original recordings in a folder
    api_response = api_instance.list_original_recordings()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->list_original_recordings: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
limit = 56 # int | The maximum number of projects to list. (optional)
offset = 56 # int | The number of projects to offset the list by. (optional)
sort = 'sort_example' # str | Sort by name, created_at or last_recording_at. (optional)
direction = 'direction_example' # str | Order projects by asc or desc. (optional)
owner = 'owner_example' # str | List projects for a specific owner ID. (optional)

try:
    # Get a list of your projects
    api_response = api_instance.list_projects(limit=limit, offset=offset, sort=sort, direction=direction, owner=owner)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->list_projects: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
project_id = 'project_id_example' # str |  (optional)
folder_id = 'folder_id_example' # str |  (optional)
limit = 56 # int |  (optional)
offset = 56 # int |  (optional)
direction = 'direction_example' # str |  (optional)

try:
    # Get a list of recordings for a specified folder or project
    api_response = api_instance.list_recordings(project_id=project_id, folder_id=folder_id, limit=limit, offset=offset, direction=direction)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->list_recordings: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))

try:
    # Get a list of the available TTS voices
    api_response = api_instance.list_tts_voices()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->list_tts_voices: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
limit = 25 # int | Limits the number of voices returned in the response. Defaults to 25. (optional) (default to 25)
offset = 0 # int | Offsets the list of voices to paginate through results. Defaults to 0. (optional) (default to 0)
sort = 'sort_example' # str | Sorts the voices by a specified attribute (e.g., name, pitch, rating, or created_at). (optional)
direction = 'direction_example' # str | Specifies the direction of sorting. Can be 'asc' for ascending or 'desc' for descending. (optional)
visibility = 'visibility_example' # str | Filters voices by their visibility status (e.g., public, paid, private, or kids). (optional)
species = 'species_example' # str | Filters voices by species category (e.g., human, animal, or other). (optional)
gender = 'gender_example' # str | Filters voices by gender (e.g., male or female). (optional)
age_group = 'age_group_example' # str | Filters voices by age group (e.g., child, young, adult, or senior). (optional)
pitch_group = 'pitch_group_example' # str | Filters voices by pitch group (e.g., low, mid, or high). (optional)
nationality = 'nationality_example' # str | Filters voices by nationality. (optional)

try:
    # Get a list of the voices available
    api_response = api_instance.list_voices(limit=limit, offset=offset, sort=sort, direction=direction, visibility=visibility, species=species, gender=gender, age_group=age_group, pitch_group=pitch_group, nationality=nationality)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->list_voices: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.ApiLoginBody() # ApiLoginBody | 

try:
    # Log in to an account and start a new session
    api_response = api_instance.login(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->login: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))

try:
    # End your session
    api_response = api_instance.logout()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->logout: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.FoldersFolderIdBody() # FoldersFolderIdBody | 
folder_id = 'folder_id_example' # str | 

try:
    # Rename a folder
    api_response = api_instance.rename_folder(body, folder_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->rename_folder: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
recording_id = 'recording_id_example' # str | 

try:
    # Retry a conversion order for a specific original
    api_instance.retry_order_v2(recording_id)
except ApiException as e:
    print("Exception when calling DefaultApi->retry_order_v2: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
name = 'name_example' # str | 
limit = 56 # int |  (optional)

try:
    # Search for a voice by its name
    api_response = api_instance.search_voices(name, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->search_voices: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.VoiceSettingsRequest() # VoiceSettingsRequest | 

try:
    # Set the settings for a voice
    api_response = api_instance.set_voice_settings(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->set_voice_settings: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.NoteRequest() # NoteRequest | 

try:
    # Update a note
    api_response = api_instance.update_note(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->update_note: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.ProjectsProjectIdBody() # ProjectsProjectIdBody | 
project_id = 'project_id_example' # str | 

try:
    # Change the name of a project
    api_response = api_instance.update_project(body, project_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->update_project: %s\n" % e)

# Configure API key authorization: ApiKeyAuth
configuration = respeecher.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: CookieAuth
configuration = respeecher.Configuration()
configuration.api_key['X-Csrf-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Csrf-Token'] = 'Bearer'

# create an instance of the API class
api_instance = respeecher.DefaultApi(respeecher.ApiClient(configuration))
body = respeecher.RecordingsRecordingIdBody() # RecordingsRecordingIdBody | 
recording_id = 'recording_id_example' # str | The ID of the recording to update

try:
    # Update a recording
    api_response = api_instance.update_recording(body, recording_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->update_recording: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.respeecher.com

Class Method HTTP request Description
DefaultApi create_calibration POST /api/calibration Create a new Calibration
DefaultApi create_folder POST /api/folders Create a folder
DefaultApi create_note POST /api/notes Create a note associated with a recording
DefaultApi create_order POST /api/v2/orders Create a conversion order
DefaultApi create_original_recording POST /api/recordings Create an original recording
DefaultApi create_project POST /api/projects Create a new project
DefaultApi create_tts_recording POST /api/v2/recordings/tts Create an original text-to-speech recording
DefaultApi delete_api_key DELETE /api/api-key Delete the API key associated with your account
DefaultApi delete_calibration DELETE /api/calibration/{calibration_id} Delete a calibration
DefaultApi delete_folder DELETE /api/folders/{folder_id} Delete a folder
DefaultApi delete_note DELETE /api/notes Delete a note
DefaultApi delete_project DELETE /api/projects/{project_id} Delete a project
DefaultApi delete_recording DELETE /api/recordings/{recording_id} Delete a recording
DefaultApi enable_calibration PUT /api/calibration/{calibration_id}/enable Set a calibration as the default enabled calibration
DefaultApi export_project GET /api/projects/{project_id}/export Export a project
DefaultApi favorite_voice POST /api/v2/voices/favorite/{voice_id} Mark a voice as a favorite
DefaultApi generate_api_key POST /api/api-key Generate a new API key
DefaultApi get_accent_samples GET /api/v2/accents/samples Get samples available for an accent
DefaultApi get_account_statistics GET /api/stats Get the statistics for your account
DefaultApi get_calibration GET /api/calibration/{calibration_id} Get a calibration by its ID
DefaultApi get_credits GET /api/credits Get the credits available to your account
DefaultApi get_folder_by_id GET /api/folders/{folder_id} Get a folder by its ID
DefaultApi get_folders_statistics POST /api/stats/folders Get statistics for a list of folders
DefaultApi get_project_by_url GET /api/projects/by-url Get a project by its URL
DefaultApi get_projects_statistics GET /api/stats/projects Get statistics for a list of projects
DefaultApi get_recording_by_id GET /api/recordings/{recording_id} Get a recording by its ID
DefaultApi list_calibrations GET /api/calibration Get a list of calibrations associated with your account
DefaultApi list_conversions GET /api/recordings/conversions Get a list of the conversions for an original recording
DefaultApi list_folders GET /api/folders Get a list of the folders in a project
DefaultApi list_original_recordings GET /api/recordings/originals Get a list of the original recordings in a folder
DefaultApi list_projects GET /api/projects Get a list of your projects
DefaultApi list_recordings GET /api/recordings Get a list of recordings for a specified folder or project
DefaultApi list_tts_voices GET /api/tts-voices Get a list of the available TTS voices
DefaultApi list_voices GET /api/v2/voices Get a list of the voices available
DefaultApi login POST /api/login Log in to an account and start a new session
DefaultApi logout POST /api/logout End your session
DefaultApi rename_folder PATCH /api/folders/{folder_id} Rename a folder
DefaultApi retry_order_v2 POST /api/v2/orders/retry/{recording_id} Retry a conversion order for a specific original
DefaultApi search_voices GET /api/v2/voices/search Search for a voice by its name
DefaultApi set_voice_settings POST /api/v2/voices/settings Set the settings for a voice
DefaultApi update_note PUT /api/notes Update a note
DefaultApi update_project PATCH /api/projects/{project_id} Change the name of a project
DefaultApi update_recording PATCH /api/recordings/{recording_id} Update a recording

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: api-key
  • Location: HTTP header

CookieAuth

  • Type: API key
  • API key parameter name: X-Csrf-Token
  • Location: HTTP header

Author

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages