ClearScribe Python SDK

Requires Python 3.10 or newer.

Install from PyPI:

pip install clearscribe-sdk

Keep your Developer Dashboard API key in the server environment as CLEARSCRIBE_API_KEY.

Import ClearScribeClient from clearscribe_sdk. Create it with ClearScribeClient(os.environ["CLEARSCRIBE_API_KEY"]) and close it with a with block.

For example, call client.get_usage() to read usage or client.transcribe("meeting.wav") to upload audio. The client also supports jobs, summaries, action items, meeting minutes, transcript questions, exports, and meetings.

API failures raise ClearScribeApiError with status and code. Requests that may consume credits are not retried automatically.

Quick start

Set CLEARSCRIBE_API_KEY in your server environment:

import os
from clearscribe_sdk import ClearScribeClient, ClearScribeApiError

try:
    with ClearScribeClient(os.environ["CLEARSCRIBE_API_KEY"]) as client:
        result = client.summarize(
            "Alex will send the revised plan on Friday.",
            output_language="en",
        )
        print(result["summary"])
except ClearScribeApiError as error:
    print(error.status, error.code, str(error))

Upload audio by passing a file path:

import os
from clearscribe_sdk import ClearScribeClient

with ClearScribeClient(os.environ["CLEARSCRIBE_API_KEY"]) as client:
    result = client.transcribe("meeting.wav")
    print(result["transcript"])

For longer recordings, create_transcription_job returns a job ID. Check progress with get_transcription_job, then call get_transcription_job_result after its status is completed.