Java SDK Reference

Installation

The AssemblyAI Java SDK requires Java 8 or higher.

Gradle

Add the dependency in your build.gradle:

1
dependencies {
2
    implementation 'com.assemblyai:assemblyai-java:x.x.x'
3
}

Maven

Add the dependency in your pom.xml:

1
<dependency>
2
    <groupId>com.assemblyai</groupId>
3
    <artifactId>assemblyai-java</artifactId>
4
    <version>x.x.x</version>
5
</dependency>

HTTP Client Usage

The SDK exports a vanilla HTTP client, AssemblyAI. You can use this to call into each of our API endpoints and get typed responses back.

1
import com.assemblyai.api.AssemblyAI;
2
3
AssemblyAI aai = AssemblyAI.builder()
4
  .apiKey("YOUR_API_KEY")
5
  .build();
6
7
Transcript transcript = aai.transcripts().get("transcript-id");
8
9
System.out.printlin("Received response!" + transcript);

Handling Errors

When the API returns a non-success status code (4xx or 5xx response), a subclass of ApiError will be thrown:

1
import com.assemblyai.api.core.ApiError;
2
3
try {
4
  aai.transcript().get("transcript-id");
5
} catch (ApiError error) {
6
  System.out.println(error.getBody());
7
  System.out.println(error.getStatusCode());
8
}

Creating a transcript

When you create a transcript, you can either pass in a URL to an audio file or upload a file directly.

1
import com.assemblyai.api.resources.transcripts.types.Transcript;
2
3
// Transcribe file at remote URL
4
Transcript transcript = aai.transcripts().transcribe(
5
        "https://assembly.ai/espn.m4a");
6
7
// Upload a file via local path and transcribe
8
transcript = aai.transcripts().transcribe(
9
        new File("./news.mp4"));

transcribe queues a transcription job and polls it until the status is completed or error. If you don’t want to wait until the transcript is ready, you can use submit:

1
import com.assemblyai.api.resources.transcripts.types.Transcript;
2
3
// Transcribe file at remote URL
4
Transcript transcript = aai.transcripts().submit(
5
        "https://assembly.ai/espn.m4a");
6
7
// Upload a file via local path and transcribe
8
transcript = aai.transcripts().submit(
9
        new File("./news.mp4"));

Using the Realtime Transcriber

The Realtime Transcriber can be used to process any live audio streams and sends data over websockets. The Realtime Transcriber will take event handlers

1
import com.assemblyai.api.RealtimeTranscriber;
2
3
RealtimeTranscriber realtime = RealtimeTranscriber.builder()
4
  .apiKey("YOUR_API_KEY")
5
  .onPartialTranscript(partial -> System.out.println(partial))
6
  .onFinalTranscript(finalTranscript -> System.out.println(finalTranscript))
7
  .build();
8
9
realtime.sendAudio(new byte[]{...});
10
11
realtime.close();

Staged Builders

The generated builders all follow the staged builder pattern. Read more here. Staged builders only allow you to construct the object once all required properties have been specified.

For example, in the snippet below, you will not be able to access the build method on CreateTranscriptParameters until you have specified the mandatory audioUrl variable.

1
import com.assemblyai.api.resources.transcripts.requests.TranscriptParams;
2
3
TranscriptParams params = TranscriptParams.builder()
4
        .audioUrl("https://...")
5
        .build();

Timeouts

The SDK uses the default timeouts of OkHttpClient:

• 10 seconds for connection timeout
• 10 seconds for read timeout
• 10 seconds for write timeout
• No timeout for call timeout

However, there are no timeouts for any LeMUR HTTP request.

To specify your own timeout, you can pass RequestOptions to each request method:

1
import com.assemblyai.api.core.RequestOptions;
2
3
// initialize client
4
5
client.transcripts()
6
        .get(
7
                "50c54d73-7a3f-44dc-af6b-f4579841b1ce",
8
                RequestOptions.builder()
9
                        .timeout(30, TimeUnit.SECONDS)
10
                        .build()
11
        );

For this operation, the call timeout will be 30 seconds, and the other timeouts will be turned off.

The default timeout should be sufficient for most use cases. However, depending on your network speed and distance, you may occasionally experience timeouts, in which case you can increase the timeout.

Android

If you’ve enabled Code shrinking using minifyEnabled, you need to add the following ProGuard configuration to keep R8 from incorrectly marking the SDK classes as unused.

-keep class com.assemblyai.api.** { *; }