Inworld API Examples

This repository contains examples to help you get started with the Inworld APIs. These examples are short snippets that demonstrate best-practices in using Inworld and accelerating your development process.

Prerequisites

	Requirement
Python	3.10+
Node.js	20+
API key	Get one at inworld.ai

Repository Structure

inworld-api-examples/
├── stt/
│   ├── python/
│   └── js/
├── tts/
│   ├── python/
│   └── js/
├── pronunciations/
│   ├── python/
│   └── js/
└── realtime/
    ├── python/
    ├── js/
    └── ios/

Getting Started

STT (Speech-to-Text)

Transcribe audio via synchronous HTTP, asynchronous jobs for long recordings, or real-time WebSocket streaming.

• Python — Sync, async and streaming STT examples in Python
• JavaScript — Sync, async and streaming STT examples in JavaScript

TTS

Covers synthesis, HTTP & WebSocket streaming, word/phoneme timestamps, long-text chunking, low-latency benchmarks, voice cloning, and voice design.

• Python — Text-to-speech examples in Python
• JavaScript — Text-to-speech examples in JavaScript

Pronunciation dictionaries

Create a multi-entry pronunciation dictionary, then use it with TTS to compare baseline and customized audio.

• Python — Separate create and synthesis examples, plus an optional CRUD lifecycle
• JavaScript — Separate create and synthesis examples, plus an optional CRUD lifecycle

Realtime

Covers WebSocket and WebRTC-based real-time voice agents with both basic and JWT authentication.

• Python — Real-time voice agent examples in Python
• JavaScript — Real-time voice agent examples in JavaScript
• iOS — Native SwiftUI WebRTC voice-agent app