Resources

Documentation

Complete technical documentation and integration guides for developers

Quick Start Guide

Get up and running with JyvStream in minutes. Follow these simple steps to integrate AI-powered audio enhancement into your application.

Get Your API Key

bash

// Add to your environment variables
JYVSTREAM_API_KEY=your_api_key_here
JYVSTREAM_PROJECT_ID=your_project_id

Install the SDK

Install the JyvStream SDK for your preferred programming language.

bash

# npm (JavaScript/TypeScript)
npm install @jyvstream/sdk

# pip (Python)
pip install jyvstream-sdk

# Go
go get github.com/jyvstream/go-sdk

Initialize the Client

Set up the JyvStream client with your API credentials.

javascript

import { JyvStream } from '@jyvstream/sdk';

const client = new JyvStream({
  apiKey: process.env.JYVSTREAM_API_KEY,
  projectId: process.env.JYVSTREAM_PROJECT_ID
});

Process Audio

Start processing audio with our real-time enhancement API.

javascript

// Real-time audio enhancement
const enhanced = await client.enhanceAudio({
  input: audioBuffer,
  preset: 'podcast', // or 'gaming', 'meeting', 'music'
  realtime: true
});

console.log('Audio enhanced successfully!');

Congratulations! 🎉

You've successfully integrated JyvStream into your application. Your audio is now being enhanced with professional-grade AI processing.

Common Use Cases

Here are some popular audio enhancement configurations for different applications.

Podcast Enhancement

Optimize audio for podcast recording

javascript

const result = await client.enhanceAudio({
  input: microphoneStream,
  preset: 'podcast',
  features: {
    noiseReduction: true,
    voiceOptimization: true,
    dynamicRange: true
  }
});

Gaming Audio

Real-time enhancement for gaming

javascript

const gameAudio = await client.enhanceAudio({
  input: gameStream,
  preset: 'gaming',
  features: {
    spatialAudio: true,
    latencyOptimized: true,
    competitiveMode: true
  }
});

Video Calls

Crystal clear communication

javascript

const meetingAudio = await client.enhanceAudio({
  input: callStream,
  preset: 'meeting',
  features: {
    echoReduction: true,
    backgroundSuppression: true,
    voiceClarity: true
  }
});

API Reference

Complete reference for all JyvStream API endpoints, SDKs, and integration options.

Core Endpoints

POST/v1/audio/enhance

Enhance Audio

Process audio with AI enhancement in real-time or batch mode

Parameters

input(AudioBuffer | Stream)required

Audio input data

preset(string)

Enhancement preset (podcast, gaming, meeting, music)

realtime(boolean)

Enable real-time processing

Response

{
  "enhanced_audio": "AudioBuffer",
  "processing_time": "number",
  "quality_score": "number",
  "metadata": "object"
}

GET/v1/audio/analyze

Analyze Audio Quality

Get detailed analysis and quality metrics for audio content

Parameters

audio_url(string)required

URL to audio file

metrics(string[])

Specific metrics to analyze

Response

{
  "quality_score": "number",
  "noise_level": "number",
  "clarity_rating": "number",
  "recommendations": "string[]"
}

POST/v1/streaming/start

Start Stream Processing

Initialize real-time audio stream processing

Parameters

stream_config(StreamConfig)required

Stream configuration object

webhook_url(string)

Webhook for stream events

Response

{
  "stream_id": "string",
  "status": "string",
  "websocket_url": "string"
}

Official SDKs

🟨

JavaScript/TypeScript

Package: @jyvstream/sdk

npm install @jyvstream/sdk

🐍

Python

Package: jyvstream-sdk

pip install jyvstream-sdk

🔵

Go

Package: github.com/jyvstream/go-sdk

go get github.com/jyvstream/go-sdk

🦀

Rust

Package: jyvstream

cargo add jyvstream

Key Features

Real-time Processing

Sub-5ms latency for live audio enhancement

Enterprise Security

End-to-end encryption and SOC 2 compliance

Global Infrastructure

Edge processing in 50+ regions worldwide

Easy Authentication

Simple API key authentication with rate limiting