---
title: iOS SDK
slug: sdk/ios-sdk
createdAt: 2026-11-04T11:40:15.847Z
---

The Kindly Chat SDK for iOS allows you to integrate a fully-featured customer support chat into your iOS application. The SDK provides a native UIKit-based chat interface with real-time messaging, push notifications, custom theming, and more.

:::hint{type="success"}
**Agent-Assisted Setup**

Point your AI coding assistant at the skill file below and it will install, initialize, and wire up Kindly for you automatically.

**Prompt to copy:**

```text
Use curl to download, read and follow: https://docs.kindly.ai/sdk/ios-sdk-skill.md
```
:::

## Installation

### Swift Package Manager

Add the Kindly SDK to your project via Xcode:

1. Go to **File > Add Package Dependencies**
2. Enter the repository URL: `https://github.com/kindly-ai/sdk-chat-ios`
3. Select the version you want to use

Or add it to your `Package.swift`:

```swift
dependencies: [
    .package(url: "https://github.com/kindly-ai/sdk-chat-ios", from: "3.0.14")
]
```

### CocoaPods

Add the following to your `Podfile`:

```ruby
pod 'Kindly'
```

Then run `pod install`.

## Quick Start

```swift
import Kindly

// Initialize the SDK
KindlySDK.start(botKey: "YOUR_BOT_KEY", market: "YOUR_MARKET")

// Display the chat
KindlySDK.displayChat()
```

## Documentation

- **Getting Started**
  Set up the SDK and configure it for your app
  [Initialization](https://docs.kindly.ai/sdk/ios-sdk-initialization) [Configuration](https://docs.kindly.ai/sdk/ios-sdk-config)
- **Chat Lifecycle**
  Control how the chat UI is displayed and managed
  [Launch Chat](https://docs.kindly.ai/sdk/ios-sdk-launch-chat) [Close Chat](https://docs.kindly.ai/sdk/ios-sdk-close-chat) [End Chat](https://docs.kindly.ai/sdk/ios-sdk-end-chat) [Kill SDK](https://docs.kindly.ai/sdk/ios-sdk-kill-sdk)
- **Features**
  Events, authentication, context, dialogues, and notifications
  [Events](https://docs.kindly.ai/sdk/ios-sdk-events) [Authentication](https://docs.kindly.ai/sdk/ios-sdk-authentication) [Notifications](https://docs.kindly.ai/sdk/ios-sdk-notification-support)
- **Customization**
  Theme the chat UI, handle links, and set up deep linking
  [Custom Theming](https://docs.kindly.ai/sdk/ios-sdk-custom-theming) [URL Schemes](https://docs.kindly.ai/sdk/ios-sdk-url-schemes) [Link Interception](https://docs.kindly.ai/sdk/ios-sdk-link-interception)

## API Reference

Auto-generated documentation for all public classes, protocols, enums, and structs.

[Browse API Reference](https://docs.kindly.ai/sdk/ios-sdk-api-reference)