ChatGPT-Java

A Java wrapper for the unofficial reverse-engineered ChatGPT API.

Important Update

OpenAI have recently implemented Cloudflare's Under Attack mode on ChatGPT, meaning you will need to supply a valid cf_clearance cookie and user agent to use the API.

This may be temporary, however we do not know at the moment.

Refer to the Registering ChatGPT section for more information on how to set these values.

Add ChatGPT-Java to your own build

Maven

<repository>
  <id>chatgpt-java</id>
  <url>https://raw.github.com/AcaiSoftware/chatgpt-java/repository/</url>
</repository>

<dependency>
  <groupId>gg.acai</groupId>
  <artifactId>chatgpt-java</artifactId>
  <version>1.0.2</version>
</dependency>

Gradle

repositories {
    maven {
        url "https://raw.github.com/AcaiSoftware/chatgpt-java/repository/"
    }
}

dependencies {
    implementation 'gg.acai:chatgpt-java:1.0.2'
}

Usage Examples

Registering ChatGPT

All builder fields are optional except for sessionToken.
Recource to access sesion token ChatGPT Cookies Chrome Extension.

ChatGPT chatGpt = ChatGPT.newBuilder()
  .sessionToken("token_here") // required field: get from cookies
  .cfClearance("cf_clearance_here") // required to bypass Cloudflare: get from cookies
  .userAgent("user_agent_here") // required to bypass Cloudflare: google 'what is my user agent'
  .addExceptionAttribute(new ParsedExceptionEntry("exception keyword", Exception.class)) // optional: adds an exception attribute
  .connectTimeout(60L) // optional: specify custom connection timeout limit
  .readTimeout(30L) // optional: specify custom read timeout limit
  .writeTimeout(30L) // optional: specify custom write timeout limit
  .build(); // builds the ChatGPT client

Session Token

Not required, the ChatGPT client checks & verifies the session token upon the build procedure. The client will throw a TokenExpiredException if the token has expired.

 chatGpt.getComplexAccessCache().refreshAccessToken() // refreshing cache and verifies session token
    .whenComplete((accessToken) -> { // called when the promise is completed, not required
        System.out.println("Access token: " + accessToken);
    });

ChatGPT Conversation

Supports both asynchronous & synchronous handling.

Create a conversation with a promise completing the response:

Conversation conversation = chatGpt.createConversation();
conversation.sendMessageAsync("Hello!")
    .whenComplete((response) -> { // called when the promise is completed with its response
        System.out.println("Response: " + response.getMessage());
    });

Create a conversation with an event stream listener:

Conversation streamConversation = chatGpt.createStreamConversation(new StreamResponseListener() {
    @Override
    public void onResponse(StreamResponse response) {
        System.out.println(response.getMessage()); // the response from the event stream
    }
});
streamConversation.sendMessageAsync("Hello!"); // does not support promise callbacks

NOTE: A Stream Conversation does not support promise callbacks with its response

Documentation

// Link to docs

Features

• Functional Style
• Sending messages with responses
• Event Stream Response
• Asynchronous & Synchronous methods
• Token Access Cache
• Conversations
• Simple Builders
• Easy to use, but powerful
• Optimal performance

Important Notes

Because this is developed using the unofficial reverse-engineered API, be aware that it could break at any time. However, we will work to fix any issues as they may arise.

Contributing

Contributions are highly appreciated! If you feel your pull request is useful, go ahead! Before creating a pull request, make sure your changes work as they should and give a description of what it provides.

Authors

Kaiser Clouke