speak-reference-architecture

Speak Reference Architecture

Overview

Production architecture for Speak language learning apps: client, API gateway, assessment engine, and progress store.

Prerequisites

• Completed speak-install-auth setup
• Valid API credentials configured
• Understanding of Speak API patterns

Instructions

Step 1: Configuration

Configure reference architecture for your Speak integration. Speak uses OpenAI's GPT-4o for AI tutoring and Whisper for speech recognition.

// speak_reference_architecture_config.ts
const config = {
  apiKey: process.env.SPEAK_API_KEY!,
  appId: process.env.SPEAK_APP_ID!,
  environment: process.env.NODE_ENV || 'development',
};

Step 2: Implementation

// Core implementation for speak reference architecture
import { SpeakClient } from '@speak/language-sdk';

const client = new SpeakClient(config);

// Production-ready implementation
async function setup() {
  const health = await client.health.check();
  console.log("Status:", health.status);
  return health;
}

Step 3: Verification

curl -sf -H "Authorization: Bearer $SPEAK_API_KEY" https://api.speak.com/v1/health | jq .

Output

• Speak Reference Architecture configured and verified
• Production-ready Speak integration
• Error handling and monitoring in place

Error Handling

Error	Cause	Solution
401 Unauthorized	Invalid API key	Verify SPEAK_API_KEY
429 Rate Limited	Too many requests	Implement backoff
Connection timeout	Network issue	Check connectivity to api.speak.com
Audio format error	Wrong codec	Convert to WAV 16kHz mono

Resources

• Speak Website
• OpenAI Realtime API
• Speak GPT-4 Blog

Next Steps

For production checklist, see speak-prod-checklist.

Examples

Basic: Apply reference architecture with default settings for a standard Speak integration.

Production: Configure with monitoring, alerting, and team-specific language learning requirements.