SDK

iOS SDK

Official Swift client library for Nur's Voice AI platform. Build native iOS voice applications with modern Swift concurrency.

GitHub Swift Package Index

Installation

Requires iOS 15.0+, macOS 12.0+. Install via Swift Package Manager:

dependencies: [
    .package(url: "https://github.com/nur-ai/nur-ios.git", from: "0.1.0")
]

Quick Start

Create a client and generate your first speech using async/await:

import NurAI
class ViewController: UIViewController {
    let client = NurClient()
    override func viewDidLoad() {
        super.viewDidLoad()
        Task {
            await generateSpeech()
        }
    }
    func generateSpeech() async {
        do {
            // Generate speech from text
            let audio = try await client.tts.generate(
                text: "Hello from iOS! This is Nur's voice AI.",
                voiceId: "rachel_v2",
                language: "en"
            )
            // Save to file
            try await audio.save(to: "output.mp3")
            print("Generated \(audio.duration)s of audio")
        } catch {
            print("Error: \(error)")
        }
    }
}

Authentication

Configure your API key during client initialization. For production apps, store it securely:

import NurAI
// Option 1: Initialize with API key
let client = NurClient(apiKey: "nur_your_api_key_here")
// Option 2: Custom configuration
let config = NurClientConfig(
    apiKey: "nur_your_api_key_here",
    baseURL: "https://api.nur.ai",
    timeout: 60,
    maxRetries: 3
)
let client = NurClient(config: config)
// Option 3: Using Info.plist (not recommended for production)
// Add NUR_API_KEY to Info.plist
let client = NurClient() // Reads from Info.plist

Text to Speech

Generate natural-sounding speech with AVFoundation integration:

import NurAI
import AVFoundation
// Basic generation
let audio = try await client.tts.generate(
    text: "Converting text to natural speech.",
    voiceId: "rachel_v2"
)
// With advanced options
let audio = try await client.tts.generate(
    text: "Converting text to natural speech.",
    voiceId: "rachel_v2",
    language: "en",
    speed: 1.0,
    pitch: 1.0,
    outputFormat: .mp3,
    sampleRate: 24000,
    enableSSML: true
)
// Save audio
try await audio.save(to: "output.mp3")
// Get audio data
let data = audio.data
// Play audio directly
let player = try AVAudioPlayer(data: audio.data)
player.play()
// Streaming generation with progress
for try await chunk in client.tts.stream(
    text: "Streaming long-form content...",
    voiceId: "rachel_v2"
) {
    print("Received \(chunk.count) bytes")
    // Process or play chunk in real-time
}

Speech to Text

High-accuracy transcription with microphone integration:

import NurAI
// Basic transcription from file
let transcript = try await client.stt.transcribe(
    file: URL(fileURLWithPath: "audio.mp3")
)
print(transcript.text)
// With speaker diarization and timestamps
let transcript = try await client.stt.transcribe(
    file: URL(fileURLWithPath: "meeting.mp3"),
    language: "en",
    speakerDiarization: true,
    timestamps: true,
    punctuationEnabled: true,
    filterProfanity: true
)
// Access segments with speaker info
for segment in transcript.segments {
    print("[Speaker \(segment.speaker)] \(segment.text)")
    print("  Time: \(segment.start)s - \(segment.end)s")
}
// Real-time microphone transcription
let stream = try await client.stt.streamTranscribe(
    language: "en",
    timestamps: true
)
// Start recording from microphone
let audioEngine = AVAudioEngine()
let inputNode = audioEngine.inputNode
let format = inputNode.outputFormat(forBus: 0)
inputNode.installTap(onBus: 0, bufferSize: 4096, format: format) { buffer, _ in
    Task {
        try await stream.send(buffer.audioBufferList)
    }
}
try audioEngine.start()
// Receive transcripts
for try await result in stream.receive() {
    print("Transcription: \(result.text) (final: \(result.isFinal))")
}

Voice Agents

Build real-time conversational AI with bidirectional streaming:

import NurAI
import AVFoundation
// Create a voice agent session
let session = try await client.voiceAgent.createSession(
    voiceId: "rachel_v2",
    language: "en",
    systemPrompt: "You are a helpful assistant.",
    temperature: 0.7,
    maxTokens: 150
)
// Setup audio engine for microphone input
let audioEngine = AVAudioEngine()
let inputNode = audioEngine.inputNode
let format = inputNode.outputFormat(forBus: 0)
// Send microphone audio to agent
inputNode.installTap(onBus: 0, bufferSize: 4096, format: format) { buffer, _ in
    Task {
        try await session.sendAudio(buffer.audioBufferList)
    }
}
try audioEngine.start()
// Receive and process agent responses
for try await response in session.receive() {
    switch response.type {
    case .transcript:
        print("User: \(response.transcript.text)")
    case .agentText:
        print("Agent: \(response.agentText)")
    case .audio:
        // Play audio response
        let player = try AVAudioPlayer(data: response.audio)
        player.play()
    }
}

Configuration Options

All available client configuration options:

Property	Type	Default	Description
apiKey	String	Required	Your API key
baseURL	String	https://api.nur.ai	API base URL
timeout	TimeInterval	30s	Request timeout
maxRetries	Int	3	Maximum retry attempts
retryDelay	TimeInterval	1s	Delay between retries
urlSession	URLSession	.shared	Custom URL session

Error Handling

The SDK provides typed errors with Swift's native error handling:

import NurAI
do {
    let audio = try await client.tts.generate(
        text: "Hello world",
        voiceId: "rachel_v2"
    )
} catch let error as NurError.RateLimit {
    print("Rate limited. Retry after \(error.retryAfter) seconds")
    try await Task.sleep(nanoseconds: UInt64(error.retryAfter) * 1_000_000_000)
    // Retry request...
} catch NurError.authentication {
    print("Authentication failed: check your API key")
} catch let error as NurError.API {
    print("API error [\(error.statusCode)]: \(error.message)")
} catch {
    print("Unexpected error: \(error)")
}
// Using Task with timeout
let task = Task {
    try await client.tts.generate(
        text: "Long text...",
        voiceId: "rachel_v2"
    )
}
do {
    try await withTimeout(seconds: 10) {
        try await task.value
    }
} catch is TimeoutError {
    print("Request timed out")
    task.cancel()
}