Storyteller Swift SDK Documentation#
Use Storyteller to add Stories, Clips, and Cards to your iOS or tvOS application. Choose the route that matches what you are trying to do.
Start Here#
For a new iOS integration:
The UIKit and SwiftUI routes are both complete; choose the framework your app uses. For Apple TV, use the tvOS Guide.
Using an AI coding assistant? The AI-assisted integration guide explains how to give it the published Storyteller documentation and, if you have access to the Storyteller iOS Showcase repository, use its $integrate-storyteller skill.
SDK and Showcase Requirements#
The SDK compatibility contract is separate from the build settings used by the Showcase applications. A deployment target determines which operating-system versions can run your app; a Showcase app's Xcode version and Swift language mode describe how that example project is built.
The current Storyteller SDK supports these application deployment targets:
| Platform | Minimum deployment target |
|---|---|
| iOS | iOS 13.0 |
| tvOS | tvOS 15.0 |
We test the current SDK line with Xcode 26.2. Earlier Xcode versions may also work, but they are not part of our tested configuration. The deployment targets above define the supported operating-system versions. The SDK binary is built in Swift 6, but it can be consumed by app targets using either Swift 5 or Swift 6 language mode.
The private iOS Showcase repository contains two deliberately modern example applications:
| Application | Installation | App deployment target | Swift language mode | Xcode used for testing |
|---|---|---|---|---|
| SwiftUI Feature Showcase | Swift Package Manager | iOS 16.0 | Swift 6 | 26.2 |
| UIKit/CocoaPods Sample | CocoaPods | iOS 16.0 | Swift 5 | 26.2 |
Those are the checked-in example configurations, not higher minimums for the SDK. Your own app can keep an iOS 13 deployment target and its existing supported Swift language mode while adopting the current SDK.
Access the iOS Showcase Source#
The iOS documentation and the private Showcase source are both available to Storyteller customers, but access is granted separately. The documentation access code supplied by Storyteller does not grant GitHub access.
To use the Showcase source links in these guides, tell your Storyteller contact which GitHub account you want authorised. Accept the resulting GitHub invitation, then make sure you are signed in with that exact account before opening a link.
The Showcase repository intentionally returns a 404 to anyone without access. If a link returns a 404, check that you are signed in to GitHub with the authorised account, that you accepted the invitation, and that Storyteller has granted that account access. Contact support@getstoryteller.com if you still cannot open the source.
Choose a Documentation Path#
Set Up or Upgrade an Integration#
Start with the iOS Quickstart Guide, follow the tvOS Guide, or migrate an existing integration from version 10.
Add a Storyteller Experience#
Choose Story and Clip Lists, Storyteller Home, Embedded Clips, or Storyteller Cards. You can also open a Player programmatically or add content Search.
Configure Your Integration#
Set up user identity and personalization, choose privacy and tracking behavior, and customize Storyteller themes.
Add Features and Integrations#
Continue with Analytics integration, the Analytics Event Reference, Ads, Deep Linking, navigation back into your app, or Brightcove.
Look Up SDK Behavior#
Use Delegates and Callbacks, Storyteller Modules, or Additional SDK Methods for API details. You can also use the documentation with AI assistants or review the release notes.
Troubleshoot or Get Help#
Start with Troubleshooting Storyteller on iOS to identify the failing boundary and the next useful check. If you still need help, contact us at support@getstoryteller.com.