How do I set up Simple-OpenAI for Android?

Add the OkHttp dependency, set minSdk to 24, and use OkHttpClientAdapter when building the SimpleOpenAI object, as outlined in the Android instructions section of the README.

Simple-OpenAI vs OpenAI's official Java SDK?

Simple-OpenAI offers broader multi-provider support and real-time features, but the official SDK may have better long-term maintenance and community backing. Choose based on need for flexibility versus vendor assurance.

How to implement streaming chat completions?

Use the createStream method in the chatCompletions service, which returns a stream of partial responses that can be processed incrementally, demonstrated in the Chat Completion with Streaming example.

Can I use Simple-OpenAI with Azure OpenAI?

Yes, via the SimpleOpenAIAzure builder class by providing the base URL, API key, and API version, though support is limited to chat completions, files, and assistants v2, as noted in the Azure OpenAI section.

What's the best way to handle errors?

Use OpenAIExceptionConverter to catch specific exceptions like AuthenticationException or RateLimitException, which include detailed OpenAIResponseInfo for debugging, per the Exception Handling section.

How to add custom retry logic?

Configure RetryConfig with attributes like maxAttempts and backoffMultiplier when building the SimpleOpenAI object, allowing automatic retries on failures, as explained in the Retrying Requests section.

Open-Awesome

simple-openai

MITJavav3.22.2

A Java HTTP client library for interacting with the OpenAI API and compatible providers in a simple, consistent manner.

GitHub

378 stars57 forks0 contributors

What is simple-openai?

Simple-OpenAI is a Java HTTP client library that provides a simple and consistent interface for interacting with the OpenAI API and compatible providers like Azure, Gemini, and Mistral. It abstracts the complexity of direct HTTP calls, offering full support for services such as chat completions, audio generation, embeddings, and real-time conversations, enabling Java developers to integrate AI capabilities seamlessly.

Target Audience

Java developers building applications that require integration with OpenAI's services or compatible AI APIs, including those working on Android apps, backend services, or enterprise solutions needing AI-powered features.

Value Proposition

Developers choose Simple-OpenAI for its minimal boilerplate, comprehensive feature support matching OpenAI's updates, and flexibility with multiple HTTP clients and AI providers, making it one of the most straightforward ways to use AI APIs in Java.

Overview

A Java library to use the OpenAI Api in the simplest possible way.

Use Cases

Best For

Adding OpenAI chat completion and function calling to Java backend services
Building Android applications that require text-to-speech or speech-to-text AI features
Integrating multimodal AI (vision, audio) into enterprise Java applications
Developing AI agents or assistants using the Assistants API v2 within a Java ecosystem
Creating real-time, speech-to-speech conversational interfaces in Java
Using structured JSON outputs from AI models for data processing pipelines

Not Ideal For

Projects requiring official, vendor-backed SDKs with guaranteed long-term support and direct OpenAI affiliation
Teams that prioritize extensive community resources, tutorials, or large ecosystems over feature completeness
Applications where minimizing third-party dependencies is critical to reduce security risks or binary size
Environments stuck on Java versions older than 11, as the library mandates Java 11+

Pros & Cons

Pros

Comprehensive API Coverage

Supports nearly all OpenAI services including audio, chat completions, embeddings, real-time WebSocket conversations, and multimodal features, keeping pace with API updates as highlighted in the Supported Services section.

Multi-Provider Flexibility

Extends compatibility to Azure OpenAI, Gemini, Mistral, and DeepSeek via dedicated builder classes, allowing seamless switching between AI providers without rewriting code, detailed in the support section.

Configurable HTTP Clients

Works with Java's HttpClient or OkHttp, enabling custom timeouts, proxies, and Android integration through client adapters, as demonstrated in the installation and usage examples.

Robust Error Handling

Provides specific exception types for HTTP errors and automatic retry with exponential backoff via RetryConfig, improving reliability in unstable network conditions, per the Exception Handling and Retrying Requests sections.

Cons

Unofficial Status Risks

As an unofficial library, it may lag behind rapid OpenAI API changes or lack the rigorous testing and support of official SDKs, potentially affecting production stability.

Complex Dependency Chain

Relies on CleverClient, Jackson, and Lombok, which can introduce compatibility conflicts, increase build times, or bloat projects compared to minimalist alternatives.

Steep Setup for Advanced Features

Configuring real-time WebSocket conversations or multi-provider integrations requires additional boilerplate and understanding of adapter patterns, as seen in the Realtime and provider-specific examples.

Frequently Asked Questions

Related Projects

LangChain4j

LangChain4j is an idiomatic, open-source Java library for building LLM-powered applications on the JVM. It offers a unified API over popular LLM providers and vector stores, and makes implementing tool calling (including MCP support), agents and RAG easy. It integrates seamlessly with enterprise Java frameworks like Quarkus and Spring Boot.

Stars12,006

Forks2,220

Last commit2 days ago

MCP Java SDK

The official Java SDK for Model Context Protocol servers and clients. Maintained in collaboration with Spring AI

Stars3,420

Forks881

Last commit4 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub