Installation

Get ShortKit installed and verified in your app. Choose your platform below.

Requirements

Platform	Minimum requirements
iOS	iOS 16.0+, Xcode 15+, Swift 5.9+
Android	Android API 24+ (Android 7.0), Kotlin 1.9+, Android Studio Hedgehog+
Flutter	Flutter 3.38+, Dart 3.10+, iOS 16.0+, Android API 24+
React Native	React Native 0.76+, iOS 16.0+, Android API 24+
Expo	Expo SDK 52+, React Native 0.76+, iOS 16.0+, Android API 24+
Web	Chrome 80+, Safari 14+, Firefox 78+, Edge 80+, Node.js 16+ (if using npm)

Package structure

Swift
Kotlin
Flutter
React Native

The SDK ships as a pre-compiled binary XCFramework via Swift Package Manager:

Product	Purpose	External dependencies
`ShortKitSDK`	Core SDK: feed, player, overlays, analytics, captions	None. Uses only Foundation, UIKit, AVFoundation, and SwiftUI.

Import the module in your code with import ShortKitSDK.

The SDK ships as a Maven artifact:

Artifact	Purpose	Key dependencies
`dev.shortkit:shortkit`	Core SDK: feed, player, overlays, analytics, captions	Media3 (ExoPlayer), OkHttp, AndroidX Fragment, ViewPager2

Transitive dependencies are resolved automatically by Gradle.

The SDK ships as a Flutter plugin package:

Package	Purpose	Key dependencies
`shortkit_flutter`	Core SDK: feed, player, overlays, analytics, captions	Native iOS and Android SDKs (bundled)

The package provides:

Export	Type	Purpose
`ShortKitProvider`	Widget	Wraps the feed and supplies API key and configuration
`ShortKitFeed`	Widget	Renders the video feed (must be inside a `ShortKitProvider`)
`ShortKitController`	Controller	Access player state (via `ValueNotifier`s) and controls
`ShortKitFeedController`	Controller	Manage custom feed items for a specific feed instance

Import from package:shortkit_flutter/shortkit_flutter.dart in your code.

The SDK ships as a single npm package that includes native modules for both platforms:

Package	Purpose	Key dependencies
`@shortkitsdk/react-native`	Core SDK: feed, player, overlays, analytics, captions	Native iOS and Android SDKs (bundled), React Native 0.76+

The package provides the following exports:

Export	Type	Purpose
`ShortKitProvider`	Component	Wraps the feed and supplies API key and configuration
`ShortKitFeed`	Component	Renders the video feed (must be inside a `ShortKitProvider`)
`useShortKitPlayer()`	Hook	Access player state and controls (play, pause, seek, captions, etc.)
`useShortKit()`	Hook	Access SDK-level methods (`setUserId`, `clearUserId`)

Import from @shortkitsdk/react-native in your code.

Package installation

Option A: Xcode UI

Open your project in Xcode

Go to File then Add Package Dependencies.

Enter the repository URL

Paste the following URL into the search field:

https://github.com/shortkit/shortkit-ios

Select your version rule

Choose Up to Next Major Version and set the minimum to 0.2.22. Click Add Package.

Add to your target

Select the ShortKitSDK library product and add it to your app target.

Option B: Package.swift

Add ShortKit to your dependencies array:

Package.swift

dependencies: [
    .package(url: "https://github.com/shortkit/shortkit-ios.git", from: "0.2.22")
]

Then add it to your target:

Package.swift

targets: [
    .target(
        name: "YourApp",
        dependencies: [
            .product(name: "ShortKitSDK", package: "shortkit-ios")
        ]
    )
]

Gradle

Add the dependency to your app-level build.gradle.kts:

build.gradle.kts

dependencies {
    implementation("dev.shortkit:shortkit:0.2.22")
}

Sync your project. In Android Studio, click Sync Now when prompted, or go to File then Sync Project with Gradle Files.No custom repository URL is needed — ShortKit is published to Maven Central, which is included by default in Android projects.

Add ShortKit to your pubspec.yaml:

pubspec.yaml

dependencies:
  shortkit_flutter: ^0.2.22

Then install:

flutter pub get

iOS setup

Ensure your iOS deployment target is 16.0 or higher in ios/Podfile:

Podfile

platform :ios, '16.0'

Then run flutter pub get again — it handles CocoaPods automatically.

Android setup

Ensure your minSdk is 24 or higher in android/app/build.gradle:

build.gradle

android {
    defaultConfig {
        minSdk = 24
    }
}

Install the package with your preferred package manager:

npm install @shortkitsdk/react-native

yarn add @shortkitsdk/react-native

Then install the iOS native dependencies:

cd ios && pod install

Install the package using the Expo CLI:

npx expo install @shortkitsdk/react-native

Add the config plugin

Add @shortkitsdk/react-native to the plugins array in your app.json (or app.config.js):

app.json

{
  "expo": {
    "plugins": [
      "@shortkitsdk/react-native"
    ]
  }
}

The plugin automatically sets the iOS deployment target to 16.0 and the Android minSdkVersion to 24.

Rebuild native projects

After adding the plugin, regenerate the native projects:

npx expo prebuild --clean

Then build and run:

npx expo run:ios

npx expo run:android

If you use EAS Build, the config plugin runs automatically during the cloud build — no need to run prebuild locally.

Option A: npm

npm install @shortkitsdk/web

Option B: CDN

Add the script tag to your HTML (includes HLS.js):

<script src="https://sdk.shortkit.dev/web/0.3.0/shortkit.min.js"></script>

Or use the slim bundle if you already load HLS.js:

<script src="https://cdn.jsdelivr.net/npm/hls.js@1/dist/hls.min.js"></script>
<script src="https://sdk.shortkit.dev/web/0.3.0/shortkit.slim.min.js"></script>

Verify installation

Build and run this minimal example to confirm the import resolves and the SDK initializes.

App.swift

import SwiftUI
import ShortKitSDK

@main
struct MyApp: App {
    let shortKit = ShortKit(
        apiKey: "pk_live_your_publishable_key",
        config: FeedConfig()
    )

    var body: some Scene {
        WindowGroup {
            ShortKitFeedView(shortKit: shortKit)
                .ignoresSafeArea()
        }
    }
}

ViewController.swift

import UIKit
import ShortKitSDK

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()

        let shortKit = ShortKit(
            apiKey: "pk_live_your_publishable_key",
            config: FeedConfig()
        )

        let feedVC = ShortKitFeedViewController(shortKit: shortKit)
        addChild(feedVC)
        feedVC.view.frame = view.bounds
        feedVC.view.autoresizingMask = [.flexibleWidth, .flexibleHeight]
        view.addSubview(feedVC.view)
        feedVC.didMove(toParent: self)
    }
}

MainActivity.kt

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import com.shortkit.sdk.ShortKit
import com.shortkit.sdk.config.FeedConfig
import com.shortkit.sdk.feed.ShortKitFeedFragment

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        val shortKit = ShortKit(
            context = this,
            apiKey = "pk_live_your_publishable_key",
            config = FeedConfig()
        )

        if (savedInstanceState == null) {
            supportFragmentManager.beginTransaction()
                .replace(android.R.id.content, ShortKitFeedFragment.newInstance(shortKit))
                .commit()
        }
    }
}

main.dart

import 'package:flutter/material.dart';
import 'package:shortkit_flutter/shortkit_flutter.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: ShortKitProvider.apiKey(
        apiKey: 'pk_live_your_publishable_key',
        child: const Scaffold(
          body: ShortKitFeed(),
        ),
      ),
    );
  }
}

App.tsx

import React from 'react';
import { ShortKitProvider, ShortKitFeed } from '@shortkitsdk/react-native';

export default function App() {
  return (
    <ShortKitProvider
      apiKey="pk_live_your_publishable_key"
      config={{ feedHeight: { type: 'fullscreen' } }}
    >
      <ShortKitFeed style={{ flex: 1 }} />
    </ShortKitProvider>
  );
}

The same React Native code works in Expo. Ensure you have added the config plugin to app.json as described in the installation step above, then run:

npx expo run:ios

App.tsx

import React from 'react';
import { ShortKitProvider, ShortKitFeed } from '@shortkitsdk/react-native';

export default function App() {
  return (
    <ShortKitProvider
      apiKey="pk_live_your_publishable_key"
      config={{ feedHeight: { type: 'fullscreen' } }}
    >
      <ShortKitFeed style={{ flex: 1 }} />
    </ShortKitProvider>
  );
}

app.js

import { ShortKit } from '@shortkitsdk/web';

const sk = new ShortKit({ apiKey: 'pk_live_your_publishable_key' });
sk.createFeed(document.getElementById('shortkit-feed'));

index.html

<div id="shortkit-feed" style="width: 400px; height: 700px;"></div>

index.html

<div id="shortkit-feed" style="width: 400px; height: 700px;"></div>

<script src="https://sdk.shortkit.dev/web/0.3.0/shortkit.min.js"></script>
<script>
  const { ShortKit } = window.ShortKit;
  const sk = new ShortKit({ apiKey: 'pk_live_your_publishable_key' });
  sk.createFeed(document.getElementById('shortkit-feed'));
</script>

If you have content uploaded to your ShortKit account, you should see a vertical video feed. If your account has no content yet, the feed will display an empty state — follow the Quickstart to upload your first video.

Get your publishable API key from the Admin Portal under Settings then API Keys. Use pk_live_... for production and pk_test_... for development.

Troubleshooting

iOS: 'No such module ShortKitSDK'

This means Xcode has not resolved the Swift Package dependency.

Verify the package URL is exactly https://github.com/shortkit/shortkit-ios
Go to File then Packages then Reset Package Caches
Clean the build folder: Product then Clean Build Folder (Shift+Cmd+K)
Close and reopen Xcode
Confirm your deployment target is iOS 16.0 or higher in your project settings

iOS: Deployment target too low

ShortKit requires iOS 16.0 or later. If you see a build error referencing a minimum deployment target:

Select your project in the Xcode navigator
Under the General tab, set Minimum Deployments to iOS 16.0 or higher
If you have multiple targets, update each one

iOS: XCFramework download fails or checksum mismatch

ShortKitSDK is distributed as a pre-compiled XCFramework. If the download fails:

Check your internet connection — the binary is downloaded from GitHub Releases
Go to File then Packages then Reset Package Caches and resolve again
If you see a checksum mismatch, ensure you are on the latest version of the package

Android: Dependency resolution failed

If Gradle cannot resolve the ShortKit dependency:

Confirm your project includes Maven Central in its repositories. Most new Android projects include it by default in settings.gradle.kts.
Check your internet connection and any proxy configuration
Run ./gradlew --refresh-dependencies to clear the dependency cache
Confirm your minSdk is 24 or higher

Android: Duplicate class errors

If you see duplicate class errors after adding ShortKit, another dependency in your project may include a conflicting version of a transitive dependency (e.g., Media3 or OkHttp).

Run ./gradlew app:dependencies to inspect the full dependency tree
Use Gradle’s resolutionStrategy or constraints block to force a consistent version

Flutter: 'shortkit_flutter' not found

If flutter pub get cannot resolve the package:

Verify the package name is exactly shortkit_flutter in your pubspec.yaml
Run flutter pub cache repair to clear the cache
Ensure you are using Flutter 3.38 or later: flutter --version

Flutter: iOS pod install fails

If pod install fails after adding the Flutter package:

Confirm your ios/Podfile has platform :ios, '16.0' or higher
Run cd ios && pod install --repo-update
If you see a CocoaPods version error, update CocoaPods: gem install cocoapods

React Native: Native module not linked

If you see an error about ShortKit not being found at runtime:

React Native CLI: Run cd ios && pod install and rebuild
Verify autolinking is enabled (check react-native.config.js is not excluding the package)
Clear the Metro cache: npx react-native start --reset-cache

Expo: Config plugin not applied / pod install fails

If the native build fails after adding the package:

Confirm "@shortkitsdk/react-native" is in the plugins array in your app.json or app.config.js
Run npx expo prebuild --clean to regenerate native projects from scratch
If using EAS Build, ensure @shortkitsdk/react-native is listed in your package.json dependencies (not just devDependencies)
Clear the Metro cache: npx expo start --clear

Web: ShortKit is not defined

If you are using the CDN script tag and see ShortKit is not defined:

Confirm the script tag loads before your code runs. Place it above your initialization script, or use the defer attribute and initialize in a DOMContentLoaded listener.
Check the browser console for network errors loading the script.
Verify you are using ShortKit (capital S, capital K) — the global is case-sensitive.

All platforms: Feed loads but shows no content

If the SDK initializes successfully but the feed is empty:

Confirm you have uploaded at least one video to your ShortKit account. You can check in the Admin Portal under Content.
Verify the video status is Ready (processing can take 1-2 minutes after upload)
Check that you are using the correct API key for the environment where your content lives (pk_live_... for production content, pk_test_... for test content)

All platforms: 401 Unauthorized error

A 401 error means the API key is invalid or not recognized:

Double-check the full key string, including the pk_live_ or pk_test_ prefix
Make sure you are using the publishable key, not the secret key, in client-side code
Verify the key has not been revoked in the Admin Portal
Confirm the key matches the environment you are targeting

Get Started

Content

Display

Build Your Experience

Users & Data

Requirements

Package structure

Package installation

Option A: Xcode UI

Option B: Package.swift

Gradle

iOS setup

Android setup

Add the config plugin

Rebuild native projects

Option A: npm

Option B: CDN

Verify installation

Troubleshooting

​Requirements

​Package structure

​Package installation

​Option A: Xcode UI

​Option B: Package.swift

​Gradle

​iOS setup

​Android setup

​Add the config plugin

​Rebuild native projects

​Option A: npm

​Option B: CDN

​Verify installation

​Troubleshooting

Requirements

Package structure

Package installation

Option A: Xcode UI

Option B: Package.swift

Gradle

iOS setup

Android setup

Add the config plugin

Rebuild native projects

Option A: npm

Option B: CDN

Verify installation

Troubleshooting