Skip to main content

Python SDK for the Signal Loom AI transcription API

Project description

Signal Loom Python SDK

Python client library for the Signal Loom AI media-to-agent ingestion API.

signal-loom-sdk-python provides a clean Python interface to the Signal Loom API, which transcribes audio and video into structured, machine-readable JSON — not raw text. Speaker diarization, entity extraction, topic classification, sentiment analysis, and word-level timestamps are all included in the standard response.

Features

  • Sync & async transcription — one-call blocking (transcribe_sync) or job-based async (transcribe + polling)
  • Structured output — Pydantic models for segments, words, speakers, entities, topics, sentiment, and summary
  • Multipart file uploads — pass a file path, file handle, or bytes
  • Exponential back-off polling — built into transcribe_sync
  • Context managerwith SignalLoom() as client: for automatic cleanup
  • LangChain integration — drop-in tool for agent pipelines

Installation

pip install signalloom

Or with uv:

uv add signalloom

Optional dependencies

# Development tools
pip install signalloom[dev]

# LangChain integration
pip install signalloom[langchain]

Quick Start

from signalloom import SignalLoom

client = SignalLoom()

# One-call synchronous transcription
result = client.transcribe_sync(url="https://example.com/podcast.mp3")

print(result.text)                    # raw concatenated text
print(result.segments[0].speaker)     # "SPEAKER_1"
print(result.summary.keywords)        # ["keyword1", "keyword2"]
print(result.model_dump_json(indent=2))  # full structured JSON

Async workflow

from signalloom import SignalLoom

client = SignalLoom()

job = client.transcribe(file=open("audio.mp3", "rb"))
print(f"Job ID: {job.job_id}")

# Poll manually
import time
while job.status not in ("completed", "failed", "cancelled"):
    time.sleep(2)
    job = client.get_job(job.job_id)

result = client.get_result(job.job_id)
print(result.text)

Configuration

Environment variable Parameter Default
SIGNAL_LOOM_API_KEY api_key None
SIGNAL_LOOM_BASE_URL base_url http://localhost:18790
# All three are equivalent:
client = SignalLoom()
client = SignalLoom(base_url="http://localhost:18790")
client = SignalLoom(api_key="sk-...", base_url="https://api.signalloom.ai")

API Reference

SignalLoom

SignalLoom(api_key=None, base_url=None, timeout=300)

Methods

  • transcribe(file=None, url=None, **kwargs) -> Job
    Submit an async transcription job. Exactly one of file or url is required.

  • transcribe_sync(file=None, url=None, timeout=None, **kwargs) -> Transcript
    One-call blocking transcription. Polls internally with exponential back-off.

  • get_job(job_id: str) -> Job
    Fetch current job status.

  • get_result(job_id: str) -> Transcript
    Fetch completed transcript.

  • cancel_job(job_id: str) -> bool
    Cancel a queued or running job.

  • list_jobs(status=None) -> List[Job]
    List all jobs, optionally filtered by status string.

Properties

  • health -> dict — Server health info (GET /health)
  • info -> ServerInfo — Server capabilities and model list (GET /v1/info)
  • models -> List[str] — Available model IDs

Transcript model

result.text                    # str — concatenated segment texts
result.segments                # List[TranscriptSegment]
result.segments[0].speaker     # str — "SPEAKER_1"
result.segments[0].words       # List[Word] — word-level timestamps
result.segments[0].entities    # List[Entity] — extracted entities
result.segments[0].sentiment   # Sentiment — label + score
result.summary.topics          # List[Topic]
result.summary.keywords        # List[str]
result.metadata.audio_duration # float — seconds

LangChain integration

from langchain.tools import StructuredTool
from signalloom import SignalLoom

def transcribe_tool(audio_url: str) -> str:
    result = SignalLoom().transcribe_sync(url=audio_url)
    return result.model_dump_json(indent=2)

tool = StructuredTool.from_function(
    transcribe_tool,
    name="transcribe_audio",
    description="Transcribe an audio or video URL to structured JSON",
)

Error handling

Exception HTTP status
SignalLoomError any error
InvalidRequestError 400
RateLimitError 429
JobFailedError job failed
TimeoutError sync timeout
from signalloom import SignalLoom, TimeoutError, JobFailedError

client = SignalLoom()
try:
    result = client.transcribe_sync(url="https://example.com/audio.mp3", timeout=60)
except TimeoutError:
    print("Job took too long")
except JobFailedError as e:
    print(f"Job failed: {e.job_id}")

Development

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Lint
ruff check signalloom/

# Type check
mypy signalloom/

License

MIT License — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

signalloom-0.1.0.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

signalloom-0.1.0-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file signalloom-0.1.0.tar.gz.

File metadata

  • Download URL: signalloom-0.1.0.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for signalloom-0.1.0.tar.gz
Algorithm Hash digest
SHA256 926c3d8369c91ac727f4cec6b79aeb4d9d0164d2814d692bbc11199cc73b488d
MD5 b2acaee26dca3b895d94bc54244870af
BLAKE2b-256 66386c8a33df651c24019913b162a9d5e3ba0b126b90e7bb6632937e213ed414

See more details on using hashes here.

File details

Details for the file signalloom-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: signalloom-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for signalloom-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 411d3e78ad8e72b2aa99c1db29e0fb635e5fdedfbad23b519400e11552ddc3a6
MD5 e52b640fdbfddf85f93b711c410b1737
BLAKE2b-256 8f14ad23916307869af35396ba1f761503d88074848a2b3a7723b09829dd9b6b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page