Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.plaud.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Choose how to build your app

There are two ways to get started with the Plaud SDK:

Full Starter App

A complete runnable iOS or Android project with all screens preconfigured. The fastest path to a working app.

SDK Only

Integrate the SDK directly into your existing app and build your own UI from scratch.

​
Full Starter App

The starter app is a production-ready template with the Plaud SDK pre-integrated. Clone it, drop in your Client ID, and run.
Prerequisites: Xcode 15.0+, iOS 14.0+ device, Xcodegen (brew install xcodegen)GitHub repository
https://github.com/Plaud-AI/plaud-template-app/tree/main/ios
1

Clone the repository

git clone https://github.com/Plaud-AI/plaud-template-app
cd plaud-template-app/ios
2

Configure credentials

Edit ios/PartnerConfig.xcconfig:
USER_ACCESS_TOKEN = your-user-access-token
PLAUD_CLIENT_ID   = your-client-id
PLAUD_SECRET_KEY  = your-secret-key
Create ios/PartnerConfig.local.xcconfig with your real credentials — it’s gitignored and will override the placeholder values.
3

Update project settings

Edit ios/project.yml:
  • Change bundleIdPrefix: com.plaud to your own Bundle ID prefix (e.g. com.yourcompany)
  • Xcode will auto-assign your Development Team on first build
4

Generate Xcode project

cd ios
xcodegen generate
5

Build & Run

Open ios/PlaudTemplateApp.xcodeproj in Xcode, select your physical device, and run.
SDK frameworks are compiled for arm64 (physical devices only). Simulator is not supported.

​
What’s included

The starter app ships with these prebuilt screens and components:

​
Onboarding

Full device pairing flow from launch to first connection.
  • Welcome screen
  • Bluetooth scanning
  • Device discovery and selection
  • Connection and secure device binding
  • Multi-device support (NotePin and Note Pro / Note)

​
Home

Main dashboard after pairing, with quick access to core actions.
  • Home screen with connected device status
  • Recording in progress state
  • Record screen

​
Files

Browse and manage all recordings synced from the device.
  • File list with recording metadata
  • Fast transfer modal for bulk sync
  • File actions (more modal)

​
Recording detail

Full detail view for each recording with three sections:
  • Transcription — Full transcript with speaker labels
  • Activity — Recording timeline and events

​
Device management

Per-device controls and status screens.
  • Device detail with battery, charging, and firmware states
  • Manage device screen
  • Firmware update flow
  • No devices connected state

​
Settings

App settings screen.

​
SDK Only

If you prefer to build your own UI, integrate the SDK directly into your project. See iOS SDK for installation and API reference.