---
source_url: https://www.pubnub.com/docs/chat/kotlin-chat-sdk
title: PubNub Kotlin Chat API & SDK Docs 1.0.1
updated_at: 2026-09-30T07:20:08.000Z
---

# PubNub Kotlin Chat API & SDK Docs 1.0.1

> For AI agents: documentation index at https://www.pubnub.com/llms-full.txt

This SDK offers a set of handy methods to create your own feature-rich chat or add a chat to your existing application.

It exposes various PubNub APIs to Kotlin with twists:

* Tailored specifically to the chat use case by offering easy-to-use methods that let you do exactly what you want, like [startTyping()](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/features/channels/typing-indicator.md#start-typing) (a message) or [join()](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/features/channels/join.md) (a channel).
* Meant to be easy & intuitive to use as it focuses on features you would most likely build in your chat app, not PubNub APIs and all the technicalities behind them.
* Offers new chat options, like [quotes](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/features/messages/quotes.md), [threads](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/features/messages/threads.md), or [read receipts](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/features/messages/read-receipts.md), that let you build a full-fledged app quickly.

Go to the **Learn** section to find out more about:

* [Access control](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/learn/access-control.md) (authentication & authorization)
* [Kotlin Chat SDK entities](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/learn/chat-entities/chat.md) (building blocks of the Kotlin Chat SDK - find out what properties they have and which methods they expose)
* [Glossary](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/learn/glossary.md)

## Installation

Integrate the Kotlin Chat SDK into your project using [Gradle](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/configuration.md#use-gradle) or [Maven](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/configuration.md#use-maven):

```bash
implementation ("com.pubnub:pubnub-chat:1.0.1")
```

Once installed, [initialize the Kotlin Chat SDK](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/configuration.md) to configure it for the features you want to implement.

The Kotlin Chat SDK is also available on [GitHub](https://github.com/pubnub/kmp-chat).

## Get started

Assuming you have read the **Learn** section and understand the idea behind the Kotlin Chat SDK's architecture, you can move to the **Build** section and start creating your own chat.

Follow these steps:

1. [Create a PubNub account](https://admin.pubnub.com/) in Admin Portal and a sample app. You'll need the publish and subscribe keys from your app's keyset to start building a chat.

   Sign upDon't feel like leaving this page to sign up?

   :::warning Required keyset configuration
   To use the
   [getChannels()](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/features/channels/list.md)
   ,
   [getChannelSuggestions()](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/features/channels/references.md)
   ,
   [getUsers()](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/features/users/list.md)
   , and
   [getUserSuggestions()](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/features/users/mentions.md)
   methods in the Chat SDKs with Access Manager, you must uncheck the
   Disallow Get All Channel Metadata
   and
   Disallow Get All User Metadata
   checkboxes in the App Context section of your keyset configuration in the
   [Admin Portal](https://admin.pubnub.com)
   .
   :::

2. Start building your own chat app:

   a. [Initialize the Kotlin Chat SDK](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/configuration.md).

   b. Create channels, users, messages, and all other [chat features](https://www.pubnub.com/docs/chat/kotlin-chat-sdk/build/features/channels/create.md).

Last updated at: 2026-09-30T07:20:08.000Z