Reference 2026-07-14 06:58 UTC to 2026-07-15 02:58 UTC

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

31 31 

32```sh32```sh

33go get -u 'github.com/openai/openai-go/v3@v3.42.0'33go get -u 'github.com/openai/openai-go/v3@v3.43.0'

34```34```

35 35 

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

2 2 

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

4 4 

5[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/4.42.0)5[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/4.43.0)

6[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/4.42.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/4.42.0)6[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/4.43.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/4.43.0)

7 7 

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

9 9 

11 11 

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

13 13 

14The 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.42.0).14The 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.43.0).

15 15 

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

17 17 

24### Gradle24### Gradle

25 25 

26```kotlin26```kotlin

27implementation("com.openai:openai-java:4.42.0")27implementation("com.openai:openai-java:4.43.0")

28```28```

29 29 

30### Maven30### Maven

33<dependency>33<dependency>

34 <groupId>com.openai</groupId>34 <groupId>com.openai</groupId>

35 <artifactId>openai-java</artifactId>35 <artifactId>openai-java</artifactId>

36 <version>4.42.0</version>36 <version>4.43.0</version>

37</dependency>37</dependency>

38```38```

39 39 

1433#### Gradle1433#### Gradle

1434 1434 

1435```kotlin1435```kotlin

1436implementation("com.openai:openai-java-spring-boot-starter:4.42.0")1436implementation("com.openai:openai-java-spring-boot-starter:4.43.0")

1437```1437```

1438 1438 

1439#### Maven1439#### Maven

1442<dependency>1442<dependency>

1443 <groupId>com.openai</groupId>1443 <groupId>com.openai</groupId>

1444 <artifactId>openai-java-spring-boot-starter</artifactId>1444 <artifactId>openai-java-spring-boot-starter</artifactId>

1445 <version>4.42.0</version>1445 <version>4.43.0</version>

1446</dependency>1446</dependency>

1447```1447```

1448 1448 

1499 1499 

1500## Jackson1500## Jackson

1501 1501 

1502The SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.1502The SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.9 by default.

1503 1503 

1504The SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).1504The SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).

1505 1505 

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

16 16 

17```ruby17```ruby

18gem "openai", "~> 0.69.0"18gem "openai", "~> 0.70.0"

19```19```

20 20 

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

107 107 

108Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).108Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).

109 109 

110## Amazon Bedrock

111 

112Use the standard client with the Bedrock provider to call OpenAI models through Amazon Bedrock's OpenAI-compatible API. Add `aws-sdk-core` to your application for AWS credential discovery and SigV4 signing:

113 

114```ruby

115gem "openai"

116gem "aws-sdk-core", "~> 3"

117```

118 

119With your normal AWS credentials configured, only the region is required:

120 

121```ruby

122require "openai"

123 

124client = OpenAI::Client.new(

125 provider: OpenAI::Providers.bedrock(region: "us-west-2")

126)

127 

128response = client.responses.create(

129 model: ENV.fetch("BEDROCK_MODEL"),

130 input: "Say hello!"

131)

132 

133puts(response.output_text)

134```

135 

136The provider uses the standard AWS credential chain, including environment credentials, `~/.aws/credentials`, `~/.aws/config`, `AWS_PROFILE`, named profiles, SSO and assume-role profiles, and workload credentials. Select a profile explicitly with:

137 

138```ruby

139client = OpenAI::Client.new(

140 provider: OpenAI::Providers.bedrock(

141 region: "us-west-2",

142 profile: "engineering"

143 )

144)

145```

146 

147`AWS_BEARER_TOKEN_BEDROCK` and explicit Bedrock bearer credentials are also supported. Bearer authentication does not load or require `aws-sdk-core`:

148 

149```ruby

150client = OpenAI::Client.new(

151 provider: OpenAI::Providers.bedrock(

152 region: "us-west-2",

153 api_key: ENV.fetch("AWS_BEARER_TOKEN_BEDROCK")

154 )

155)

156```

157 

158See [bedrock.md](bedrock.md) for authentication precedence, static and refreshable credentials, endpoint configuration, and SigV4 request constraints.

159 

110## Workload Identity Authentication160## Workload Identity Authentication

111 161 

112For secure, automated environments like cloud-managed Kubernetes, Azure, and GCP, you can use workload identity authentication with short-lived tokens from cloud identity providers instead of long-lived API keys.162For secure, automated environments like cloud-managed Kubernetes, Azure, and GCP, you can use workload identity authentication with short-lived tokens from cloud identity providers instead of long-lived API keys.

232- `File` (or an object with the same structure)232- `File` (or an object with the same structure)

233- a `fetch` `Response` (or an object with the same structure)233- a `fetch` `Response` (or an object with the same structure)

234- an `fs.ReadStream`234- an `fs.ReadStream`

235- the return value of our `toFile` helper235- the return value of our `toFile` or `toStreamingFile` helpers

236 236 

237```ts237```ts

238import fs from 'fs';238import fs from 'fs';

239import OpenAI, { toFile } from 'openai';239import OpenAI, { toFile, toStreamingFile } from 'openai';

240 240 

241const client = new OpenAI();241const client = new OpenAI();

242 242 

261 file: await toFile(new Uint8Array([0, 1, 2]), 'input.jsonl'),261 file: await toFile(new Uint8Array([0, 1, 2]), 'input.jsonl'),

262 purpose: 'fine-tune',262 purpose: 'fine-tune',

263});263});

264 

265// `toFile()` creates a web File, so it must buffer stream inputs before sending them.

266// Use `toStreamingFile()` to stream an arbitrary web, Node, or cloud-storage stream directly:

267await client.files.create({

268 file: toStreamingFile(myReadableStream, 'input.jsonl', { type: 'application/jsonl' }),

269 purpose: 'fine-tune',

270});

264```271```

265 272 

266## Webhook Verification273## Webhook Verification