https://github.com/oracle-samples/oci-genai-auth-java
OCI GenAI Auth for Java — OCI request-signing library for OpenAI-compatible APIs on Oracle Cloud Infrastructure Generative AI
https://github.com/oracle-samples/oci-genai-auth-java
agenthub authentication generative-ai java oci oci-genai openai oracle-cloud
Last synced: 1 day ago
JSON representation
OCI GenAI Auth for Java — OCI request-signing library for OpenAI-compatible APIs on Oracle Cloud Infrastructure Generative AI
- Host: GitHub
- URL: https://github.com/oracle-samples/oci-genai-auth-java
- Owner: oracle-samples
- License: upl-1.0
- Created: 2026-03-19T08:10:38.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-06-09T04:22:06.000Z (29 days ago)
- Last Synced: 2026-06-10T03:32:58.769Z (28 days ago)
- Topics: agenthub, authentication, generative-ai, java, oci, oci-genai, openai, oracle-cloud
- Language: Java
- Homepage:
- Size: 121 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
# oci-genai-auth-java
The **OCI GenAI Auth** Java library provides OCI request-signing helpers for the OpenAI-compatible REST APIs hosted by OCI Generative AI.
## Table of Contents
- [Installation](#installation)
- [Using OCI IAM Auth](#using-oci-iam-auth)
- [Using API Key Auth](#using-api-key-auth)
- [Using OCI Enterprise AI Agents APIs](#using-oci-enterprise-ai-agents-apis)
- [Examples](#examples)
- [Release Notes](#release-notes)
- [Contributing](#contributing)
- [Security](#security)
- [License](#license)
## Installation
Requires **Java 17+** and **Maven 3.8+**.
`oci-genai-auth-java` is designed to work together with the official [OpenAI Java SDK](https://github.com/openai/openai-java).
```xml
com.oracle.genai
oci-genai-auth-java-bom
1.0.11
pom
import
com.oracle.genai
oci-genai-auth-java-core
```
## Using OCI IAM Auth
Use OCI IAM auth when you want to sign requests with your OCI profile (session/user/resource/instance principal). Recommended if you are building OCI-native production workloads.
```java
import com.oracle.genai.auth.OciAuthConfig;
import com.oracle.genai.auth.OciOkHttpClientFactory;
import com.oracle.genai.auth.OciOpenAIHttpClient;
import com.openai.client.OpenAIClient;
import com.openai.client.OpenAIClientImpl;
import com.openai.core.ClientOptions;
import okhttp3.OkHttpClient;
OciAuthConfig config = OciAuthConfig.builder()
.authType("security_token")
.profile("DEFAULT")
.build();
OkHttpClient ociHttpClient = OciOkHttpClientFactory.build(config);
String baseUrl = "https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/openai/v1";
OpenAIClient client = new OpenAIClientImpl(ClientOptions.builder()
.httpClient(OciOpenAIHttpClient.of(ociHttpClient, baseUrl))
.baseUrl(baseUrl)
.apiKey("not-used")
.build());
```
## Using API Key Auth
Use OCI Generative AI API Keys if you want a long-lived API key style auth. Recommended if you are migrating from other OpenAI-compatible API providers.
To create the OCI Generative AI API Keys, follow [this guide](https://docs.oracle.com/en-us/iaas/Content/generative-ai/api-keys.htm).
You don't need to install `oci-genai-auth-java` if you use API key auth.
```java
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
OpenAIClient client = OpenAIOkHttpClient.builder()
.baseUrl("https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/openai/v1")
.apiKey(System.getenv("OCI_GENAI_API_KEY"))
.build();
```
## Using OCI Enterprise AI Agents APIs
OCI Enterprise AI Agents provides a unified API for interacting with models and agentic capabilities.
- It is compatible with OpenAI's Responses API and the [Open Responses Spec](https://www.openresponses.org/specification), enabling developers to build agents with OpenAI SDK, OpenAI Agents SDK, LangChain, LangGraph, AI SDK, CrewAI, and more.
- It offers a uniform interface, auth, billing to access multiple model providers including OpenAI, Gemini, xAI, and GPT-OSS models hosted in OCI and your Dedicated AI Cluster.
- It provides built-in agentic primitives such as agent loop, reasoning, short-term memory, long-term memory, web search, file search, image generation, code execution, and more.
In addition to the compatible endpoint to Responses API, OCI Enterprise AI Agents also offers compatible endpoints to Files API, Vector Stores API, and Containers API.
Explore [examples](examples/enterprise_ai_agents) to get started.
Note: OpenAI commercial models and image generation are only available to Oracle internal teams at this moment.
```java
import com.oracle.genai.auth.OciAuthConfig;
import com.oracle.genai.auth.OciOkHttpClientFactory;
import com.oracle.genai.auth.OciOpenAIHttpClient;
import com.openai.client.OpenAIClient;
import com.openai.client.OpenAIClientImpl;
import com.openai.core.ClientOptions;
import okhttp3.OkHttpClient;
OciAuthConfig config = OciAuthConfig.builder()
.authType("security_token")
.profile("DEFAULT")
.build();
OkHttpClient ociHttpClient = OciOkHttpClientFactory.build(config);
String baseUrl = "https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/openai/v1";
OpenAIClient client = new OpenAIClientImpl(ClientOptions.builder()
.httpClient(OciOpenAIHttpClient.of(ociHttpClient, baseUrl))
.baseUrl(baseUrl)
.apiKey("not-used")
.putHeader("openai-project", "ocid1.generativeaiproject.oc1.us-chicago-1.aaaaaaaaexample")
.build());
```
## Examples
Demo code and instructions on how to run them can be found in [examples](examples/) folder.
## Release Notes
See [RELEASE_NOTES.md](./RELEASE_NOTES.md).
## Contributing
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
## Security
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process
## License
Copyright (c) 2026 Oracle and/or its affiliates.
Released under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.