Kotlin client for OpenAI's API with multiplatform and coroutines capabilities.

📦 Setup

1. Install OpenAI API Kotlin client by adding the following dependency to your build.gradle file:

repositories {
    mavenCentral()
}

dependencies {
    implementation "com.aallam.openai:openai-client:3.4.0"
}

1. Choose and add to your dependencies one of Ktor's engines.

BOM

Alternatively, you can use openai-client-bom by adding the following dependency to your build.gradle file

dependencies {
    // import Kotlin API client BOM
    implementation platform('com.aallam.openai:openai-client-bom:3.4.0')

    // define dependencies without versions
    implementation 'com.aallam.openai:openai-client'
    runtimeOnly 'io.ktor:ktor-client-okhttp'
}

Multiplaform

In multiplatform projects, add openai client dependency to commonMain, and choose an engine for each target.

⚡️ Getting Started

Note: OpenAI encourages using environment variables for the API key. Read more.

Create an instance of OpenAI client:

val openai = OpenAI(
    token = "your-api-key",
    timeout = Timeout(socket = 60.seconds),
    // additional configurations...
)

Or you can create an instance of OpenAI using a pre-configured OpenAIConfig:

val config = OpenAIConfig(
    token = apiKey,
    timeout = Timeout(socket = 60.seconds),
    // additional configurations...
)

val openAI = OpenAI(config)

Use your OpenAI instance to make API requests. Learn more.

Supported features

• Models
• Chat
• Images
• Embeddings
• Files
• Fine-tunes
• Moderations
• Audio

Legacy

• Completions

Deprecated

• Edits

📚 Guides

Get started and understand more about how to use OpenAI API client for Kotlin with these guides:

• Getting Started
• Chat with Function Call
• FileSource Guide

ℹ️ Sample apps

Sample apps are available under sample, please check the README for running instructions.

🔒 ProGuard / R8

The specific rules are already bundled into the Jar which can be interpreted by R8 automatically.

📸 Snapshots

Learn how to import snapshot version

To import snapshot versions into your project, add the following code snippet to your gradle file: groovy repositories { //... maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' } }

🛠️ Throubleshooting

For common issues and their solutions, check the Troubleshooting Guide.

⭐️ Support

Appreciate the project? Here's how you can help:

1. Star: Give it a star at the top right. It means a lot!
2. Contribute: Found an issue or have a feature idea? Submit a PR.
3. Feedback: Have suggestions? Open an issue or start a discussion.

📄 License

OpenAI Kotlin API Client is an open-sourced software licensed under the MIT license. This is an unofficial library, it is not affiliated with nor endorsed by OpenAI. Contributions are welcome.