Quick Start Guide

    Get up and running with OneBudd STS in under 5 minutes.

    Prerequisites

    • Node.js 18+ or Python 3.8+ or Go 1.21+
    • OneBudd API key (get one from your dashboard)

    Install the SDK

    JavaScript / TypeScript

    Terminal
    npm install @onebudd/sdk
    # or
    pnpm add @onebudd/sdk
    # or
    yarn add @onebudd/sdk

    Python

    Terminal
    pip install onebudd

    Go

    Terminal
    go get github.com/onebudd/onebudd-sdk-go

    Quick Start Examples

    JavaScript

    app.js
    import { OneBuddClient } from '@onebudd/sdk';
    
    const client = new OneBuddClient({
      baseUrl: 'wss://api.onebudd.com'
    });
    
    client.on('audio', (audioData) => {
      // Play received audio
      playAudio(audioData);
    });
    
    client.on('transcript', (data) => {
      console.log('Transcript:', data.text);
    });
    
    await client.startSession({ auth_token: 'your_token' });
    client.sendAudio(audioBuffer);

    Python

    app.py
    from onebudd import OneBuddClient
    
    client = OneBuddClient(base_url="wss://api.onebudd.com")
    
    @client.on_audio
    def handle_audio(audio_data):
        play_audio(audio_data)
    
    @client.on_transcript
    def handle_transcript(data):
        print(f"Transcript: {data['text']}")
    
    await client.start_session(auth_token="your_token")
    client.send_audio(audio_buffer)

    Go

    main.go
    import "github.com/onebudd/onebudd-sdk-go"
    
    client := onebudd.NewClient(onebudd.Config{
        BaseURL: "wss://api.onebudd.com",
    })
    
    client.OnAudio = func(data []byte) {
        playAudio(data)
    }
    
    client.OnTranscript = func(text string, isFinal bool) {
        fmt.Printf("Transcript: %s\n", text)
    }
    
    client.StartSession(ctx, "your_token")
    client.SendAudio(audioBuffer)

    What's Next?