Installation & Quickstart

Prerequisites

Requirement	Minimum
iOS	17.0
macOS	14.0
Swift	6.0
Xcode	16
SwiftUI	Not required. The SDK works with UIKit or any UI framework.

Installation

The SDK ships as a Swift Package.

Xcode
Package.swift

File → Add Package Dependencies…

Paste the repository URL:

https://github.com/Chatbase-co/chatbase-ios-sdk.git

Choose version 0.1.0-beta.1 (or Up to Next Minor) and add the ChatbaseSDK library to your app target.

// Package.swift
dependencies: [
    .package(
        url: "https://github.com/Chatbase-co/chatbase-ios-sdk.git",
        from: "0.1.0-beta.1"
    )
],
targets: [
    .target(
        name: "YourApp",
        dependencies: [
            .product(name: "ChatbaseSDK", package: "chatbase-ios-sdk")
        ]
    )
]

Then import it:

import ChatbaseSDK

No Info.plist changes are needed. The SDK talks to https://www.chatbase.co over HTTPS, which iOS allows by default.

Quick Start

Get your Agent ID

Go to the Chatbase Dashboard
Select your AI agent
Go to Settings → General
Copy the Agent ID

Enable the iOS SDK channel

In the dashboard, go to Deploy → iOS SDK and enable the channel for your AI agent.

If the iOS SDK channel is not enabled, every SDK request fails with a 404 AGENT_NOT_FOUND error, even when the agent ID is correct.

Create a client

import ChatbaseSDK

let client = ChatbaseClient(agentId: "YOUR_AGENT_ID")

Create the client once and keep it around, in a view model, an app-level dependency, or a @State property. A new client starts anonymous, tied to a device ID that stays the same across launches. For configuration options, see ChatbaseClient.

Send your first message

let response = try await client.send("Hello! How can you help me?") { cb in
    cb.onTextDelta = { chunk in
        // Runs for each chunk of text as it arrives
        print(chunk, terminator: "")
    }
}

print(response.message.text)
print("Conversation: \(response.conversationId)")
print("Credits used: \(response.usage.credits)")

See ChatResponse for every field on the response.

Continue the conversation

let followUp = try await client.send(
    "Tell me more",
    conversationId: response.conversationId
)

For UI code, use ConversationState instead. It keeps the conversation ID for you, along with the message list.

There is no close() or cleanup call. The client shuts down its network session when it goes out of scope.

Next Steps

Streaming

Stream replies with async/await and callbacks

SwiftUI

Ready-made state for chat screens

Client-Side Tools

Let the AI agent run functions on the device

ChatbaseClient

Initializer, properties, and methods

SDKs

Android SDK

iOS SDK

Installation & Quickstart

Prerequisites

Installation

Quick Start

Next Steps

Streaming

SwiftUI

Client-Side Tools

ChatbaseClient

​Prerequisites

​Installation

​Quick Start

​Next Steps

Streaming

SwiftUI

Client-Side Tools

ChatbaseClient

Prerequisites

Installation

Quick Start

Next Steps