Skip to content

[Proposal] Adding FastAPI interface for improved accessibility and integration #349

@rover0811

Description

@rover0811

Context

I've been exploring the whisper-live project and see great potential for it in web applications and microservices. While the current client-server architecture works well for Python developers, integrating with other languages and frameworks requires extra effort.

Proposal

I'd like to contribute a FastAPI interface that would:

  • Keep all existing functionality intact
  • Add a REST API for file uploads and processing requests
  • Provide WebSocket endpoints for streaming transcription results
  • Include automatic API documentation

Benefits

  • Enable easy integration from any language/framework
  • Simplify containerized deployment
  • Allow usage in microservice architectures
  • Reduce client-side implementation complexity

Implementation Plan

The implementation would be provided as run_server_fastapi.py, working alongside the existing server code without replacing it. It would use the same underlying transcription engine while adding standardized HTTP/WebSocket interfaces.

Would this addition be valuable to the project? I'm happy to start work on this if it aligns with the project's goals.

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions