README.md

otterai-api

Unofficial Python API for otter.ai

Contents

• Installation
• Setup
• APIs
  • User
  • Speeches
  • Speakers
  • Folders
  • Groups
  • Notifications
• Exceptions

Installation

pip install .

or in a virtual environment

python3 -m venv env
source env/bin/activate
pip install .

Setup

from otterai import OtterAI
otter = OtterAI()
otter.login('USERNAME', 'PASSWORD')

APIs

User

Get user specific data

otter.get_user()

Speeches

Get all speeches

optional parameters: folder, page_size, source

otter.get_speeches()

Get speech by id

otter.get_speech(SPEECH_ID)

Query a speech

otter.query_speech(QUERY, SPEECH_ID)

Upload a speech

optional parameters: content_type (default audio/mp4)

otter.upload_speech(FILE_NAME)

Download a speech

optional parameters: filename (defualt id), format (default: all available (txt,pdf,mp3,docx,srt) as zip file)

otter.download_speech(SPEECH_ID, FILE_NAME)

Move a speech to trash

otter.move_to_trash_bin(SPEECH_ID)

TODO

Start a live speech

Speakers

Get all speakers

otter.get_speakers()

Create a speaker

otter.create_speaker(SPEAKER_NAME)

TODO

Assign a speaker to speech transcript

Folders

Get all folders

otter.get_folders()

Groups

Get all groups

otter.list_groups()

Notifications

Get notification settings

otter.get_notification_settings()

Exceptions

from otterai import OtterAIException

try: 
 ...
except OtterAIException as e:
 ...