otterai-py 0.0.2

Unofficial Otter.ai Python API

otterai-py

Unofficial Python API for otter.ai

Note: This project is a fork of gmchad/otterai-api, as the original repository appears to be abandoned. Improvements and updates will be maintained here.

Contents

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

Installation

Install via pip:

pip install .[dev]

or in a virtual environment:

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

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 a speech by ID:

otter.get_speech(OTID)

Query a speech:

otter.query_speech(QUERY, OTID)

Upload a speech.

Optional parameters: content_type (default: audio/mp4)

otter.upload_speech(FILE_NAME)

Download a speech.

Optional parameters: filename (default: id), format (default: all available formats (txt,pdf,mp3,docx,srt) as a zip file)

otter.download_speech(OTID, FILE_NAME)

Move a speech to the trash:

otter.move_to_trash_bin(OTID)

Set speech title:

otter.set_speech_title(OTID, TITLE)

TODO

• Start a live speech
• Stop a live speech
• Assign a speaker to a speech transcript

Speakers

Get all speakers:

otter.get_speakers()

Create a speaker:

otter.create_speaker(SPEAKER_NAME)

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:
    ...

Contribution

To contribute to this project, follow these steps:

1. Create a .env file in the root directory with the following content:

   OTTERAI_USERNAME=""
   OTTERAI_PASSWORD=""
   TEST_OTTERAI_SPEECH_OTID=""
   

   • Replace OTTERAI_USERNAME and OTTERAI_PASSWORD with your Otter.ai credentials.
   • Replace TEST_OTTERAI_SPEECH_OTID with the ID of a speech you create on Otter.ai. This is required for the tests to pass.

2. To run the tests and the main.py file, execute the run.sh script:

   ./run.sh
   

3. Ensure all tests pass and make necessary updates to the tests if you modify or add functionality.

4. Submit a pull request with a clear description of your changes.