Amigo AIAmigo AI
Back to Docs

Getting Started with Amigo AI SDK

Amigo AI SDK lets you add real-time face swap to your iOS app. Drop-in SwiftUI camera view, per-frame API for WebRTC, and static image swap — all on-device at 512px resolution.

Prerequisites

  • An Amigo AI API key (sign up free)
  • iOS 16+ with Xcode 15+
  • Swift 5.9+

Installation (Swift Package Manager)

Add the package to your Xcode project:

https://github.com/AmigoAIAdmin/amigo_sdk_reference.git

Or add to your Package.swift:

dependencies: [
    .package(url: "https://github.com/AmigoAIAdmin/amigo_sdk_reference.git", from: "1.0.0")
]

Quick Start — Live Camera (SwiftUI)

import AmigoFaceSwapSDK

// 1. Download models during onboarding (free, one-time)
try await AmigoFaceSwap.downloadModelsIfNeeded { progress in
    print("Downloading: \(Int(progress * 100))%")
}

// 2. Initialize the SDK (paid — $0.01/session)
try await AmigoFaceSwap.initialize(apiKey: "your-api-key")

// 3. Enroll a target face
let latent = try await AmigoFaceSwap.enrollFace(from: targetPhoto)

// 4. Drop-in live camera with face swap
AmigoLiveCameraView(targetLatent: latent)

Quick Start — Live Camera (UIKit)

import AmigoFaceSwapSDK

try await AmigoFaceSwap.initialize(apiKey: "your-api-key")
let latent = try await AmigoFaceSwap.enrollFace(from: targetPhoto)
let vc = AmigoLiveViewController(targetLatent: latent)
present(vc, animated: true)

Quick Start — Static Image

let swapped = try await AmigoFaceSwap.swapFace(
    in: sourceImage,
    using: latent
)
imageView.image = swapped

Next Steps

iOS Integration Guide