Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "4.29.0"
".": "4.29.1"
}
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Changelog

## 4.29.1 (2026-03-18)

Full Changelog: [v4.29.0...v4.29.1](https://github.com/openai/openai-java/compare/v4.29.0...v4.29.1)

### Bug Fixes

* **client:** allow updating header/query affecting fields in `toBuilder()` ([fd3b67c](https://github.com/openai/openai-java/commit/fd3b67cef9c4457506a76b9e994210e512e0181f))
* **client:** remove redundant apiKey override ([8383a7d](https://github.com/openai/openai-java/commit/8383a7de659aa6f17e1707614f5a246ced127532))

## 4.29.0 (2026-03-17)

Full Changelog: [v4.28.0...v4.29.0](https://github.com/openai/openai-java/compare/v4.28.0...v4.29.0)
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

<!-- x-release-please-start-version -->

[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/4.29.0)
[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/4.29.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/4.29.0)
[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/4.29.1)
[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/4.29.1/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/4.29.1)

<!-- x-release-please-end -->

The OpenAI Java SDK provides convenient access to the [OpenAI REST API](https://platform.openai.com/docs) from applications written in Java.

<!-- x-release-please-start-version -->

The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.openai/openai-java/4.29.0).
The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.openai/openai-java/4.29.1).

<!-- x-release-please-end -->

Expand All @@ -24,7 +24,7 @@ The REST API documentation can be found on [platform.openai.com](https://platfor
### Gradle

```kotlin
implementation("com.openai:openai-java:4.29.0")
implementation("com.openai:openai-java:4.29.1")
```

### Maven
Expand All @@ -33,7 +33,7 @@ implementation("com.openai:openai-java:4.29.0")
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
<version>4.29.0</version>
<version>4.29.1</version>
</dependency>
```

Expand Down Expand Up @@ -1342,7 +1342,7 @@ If you're using Spring Boot, then you can use the SDK's [Spring Boot starter](ht
#### Gradle

```kotlin
implementation("com.openai:openai-java-spring-boot-starter:4.29.0")
implementation("com.openai:openai-java-spring-boot-starter:4.29.1")
```

#### Maven
Expand All @@ -1351,7 +1351,7 @@ implementation("com.openai:openai-java-spring-boot-starter:4.29.0")
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java-spring-boot-starter</artifactId>
<version>4.29.0</version>
<version>4.29.1</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ repositories {

allprojects {
group = "com.openai"
version = "4.29.0" // x-release-please-version
version = "4.29.1" // x-release-please-version
}

subprojects {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -533,9 +533,7 @@ private constructor(
headers.put("X-Stainless-Runtime", "JRE")
headers.put("X-Stainless-Runtime-Version", getJavaVersion())
headers.put("X-Stainless-Kotlin-Version", KotlinVersion.CURRENT.toString())
organization?.let { headers.put("OpenAI-Organization", it) }
project?.let { headers.put("OpenAI-Project", it) }

// We replace after all the default headers to allow end-users to overwrite them.
headers.replaceAll(this.headers.build())
when (credential) {
is AzureApiKeyCredential -> {
Expand Down Expand Up @@ -568,6 +566,8 @@ private constructor(
}

queryParams.replaceAll(this.queryParams.build())
organization?.let { headers.replace("OpenAI-Organization", it) }
project?.let { headers.replace("OpenAI-Project", it) }

return ClientOptions(
httpClient,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,44 @@ internal class ClientOptionsTest {

private val httpClient = mock<HttpClient>()

@Test
fun putHeader_canOverwriteDefaultHeader() {
val clientOptions =
ClientOptions.builder()
.httpClient(httpClient)
.putHeader("User-Agent", "My User Agent")
.apiKey("My API Key")
.build()

assertThat(clientOptions.headers.values("User-Agent")).containsExactly("My User Agent")
}

@Test
fun toBuilder_organizationCanBeUpdated() {
var clientOptions =
ClientOptions.builder()
.httpClient(httpClient)
.organization("My Organization")
.apiKey("My API Key")
.build()

clientOptions = clientOptions.toBuilder().organization("another My Organization").build()

assertThat(clientOptions.headers.values("OpenAI-Organization"))
.containsExactly("another My Organization")
}

@Test
fun toBuilder_bearerAuthCanBeUpdated() {
var clientOptions =
ClientOptions.builder().httpClient(httpClient).apiKey("My API Key").build()

clientOptions = clientOptions.toBuilder().apiKey("another My API Key").build()

assertThat(clientOptions.headers.values("Authorization"))
.containsExactly("Bearer another My API Key")
}

@Test
fun toBuilder_whenOriginalClientOptionsGarbageCollected_doesNotCloseOriginalClient() {
var clientOptions =
Expand Down
Loading