Arcade Java API Library

The Arcade Java SDK provides convenient access to the Arcade REST API from applications written in Java.

It is generated with Stainless.

The REST API documentation can be found on docs.arcade.dev. Javadocs are available on javadoc.io.

Installation

Gradle

implementation("dev.arcade:arcade-java:0.1.0-alpha.5")

Maven

<dependency>
<groupId>dev.arcade</groupId>
<artifactId>arcade-java</artifactId>
<version>0.1.0-alpha.5</version>
</dependency>

Requirements

This library requires Java 8 or later.

Usage

importdev.arcade.client.ArcadeClient;
importdev.arcade.client.okhttp.ArcadeOkHttpClient;
importdev.arcade.models.tools.ExecuteToolRequest;
importdev.arcade.models.tools.ExecuteToolResponse;
importdev.arcade.models.tools.ToolExecuteParams;
// Configures using the `arcade.apiKey` and `arcade.baseUrl` system properties// Or configures using the `ARCADE_API_KEY` and `ARCADE_BASE_URL` environment variablesArcadeClientclient = ArcadeOkHttpClient.fromEnv();
ExecuteToolRequestparams = ExecuteToolRequest.builder()
.toolName("tool_name")
.build();
ExecuteToolResponseexecuteToolResponse = client.tools().execute(params);

Client configuration

Configure the client using system properties or environment variables:

importdev.arcade.client.ArcadeClient;
importdev.arcade.client.okhttp.ArcadeOkHttpClient;
// Configures using the `arcade.apiKey` and `arcade.baseUrl` system properties// Or configures using the `ARCADE_API_KEY` and `ARCADE_BASE_URL` environment variablesArcadeClientclient = ArcadeOkHttpClient.fromEnv();

Or manually:

importdev.arcade.client.ArcadeClient;
importdev.arcade.client.okhttp.ArcadeOkHttpClient;
ArcadeClientclient = ArcadeOkHttpClient.builder()
.apiKey("My API Key")
.build();

Or using a combination of the two approaches:

importdev.arcade.client.ArcadeClient;
importdev.arcade.client.okhttp.ArcadeOkHttpClient;
ArcadeClientclient = ArcadeOkHttpClient.builder()
// Configures using the `arcade.apiKey` and `arcade.baseUrl` system properties// Or configures using the `ARCADE_API_KEY` and `ARCADE_BASE_URL` environment variables
.fromEnv()
.apiKey("My API Key")
.build();

See this table for the available options:

Setter	System property	Environment variable	Required	Default value
apiKey	arcade.apiKey	ARCADE_API_KEY	true	-
baseUrl	arcade.baseUrl	ARCADE_BASE_URL	false	"https://api.arcade.dev"

System properties take precedence over environment variables.

Tip

Don't create more than one client in the same application. Each client has a connection pool and thread pools, which are more efficient to share between requests.

Modifying configuration

To temporarily use a modified client configuration, while reusing the same connection and thread pools, call withOptions() on any client or service:

importdev.arcade.client.ArcadeClient;
ArcadeClientclientWithOptions = client.withOptions(optionsBuilder -> {
optionsBuilder.baseUrl("https://example.com");
optionsBuilder.maxRetries(42);
});

The withOptions() method does not affect the original client or service.

User Authentication

To initiate an OAuth 2 authenticated flow with a user, use the AuthService.start method:

importdev.arcade.client.ArcadeClient;
importdev.arcade.models.AuthorizationResponse;
// See above on creating a clientArcadeClientclient;
// get the auth service, and call startAuthorizationResponseauthResponse = client.auth().start(
"{arcade_user_id}", // email or user ID of an Arcade user"{auth_provider}", // provider name"oauth2", // provider typeList.of("{scope1}", "{scope2}")); // list of scopes// check the response statusauthResponse.status()
.filter(status -> status != AuthorizationResponse.Status.COMPLETED)
.ifPresent(status ->
System.out.println("Click this link to authorize: " + authResponse.url().get()));

// if the authorization is NOT complete, you can wait using the following method:client.auth().waitForCompletion(authResponse);

Caution

This method should not be used in web applications as it will block the current thread. For web apps, you will need to poll the status endpoint by calling client.auth.status(...).

For more details, see the Authorized Tool Calling docs.

Requests and responses

To send a request to the Arcade API, build an instance of some Params class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.

For example, client.tools().execute(...) should be called with an instance of ToolExecuteParams, and it will return an instance of ExecuteToolResponse.

Immutability

Each class in the SDK has an associated builder or factory method for constructing it.

Each class is immutable once constructed. If the class has an associated builder, then it has a toBuilder() method, which can be used to convert it back to a builder for making a modified copy.

Because each class is immutable, builder modification will never affect already built class instances.

Asynchronous execution

The default client is synchronous. To switch to asynchronous execution, call the async() method:

importdev.arcade.client.ArcadeClient;
importdev.arcade.client.okhttp.ArcadeOkHttpClient;
importdev.arcade.models.tools.ExecuteToolRequest;
importdev.arcade.models.tools.ExecuteToolResponse;
importdev.arcade.models.tools.ToolExecuteParams;
importjava.util.concurrent.CompletableFuture;
// Configures using the `arcade.apiKey` and `arcade.baseUrl` system properties// Or configures using the `ARCADE_API_KEY` and `ARCADE_BASE_URL` environment variablesArcadeClientclient = ArcadeOkHttpClient.fromEnv();
ExecuteToolRequestparams = ExecuteToolRequest.builder()
.toolName("tool_name")
.build();
CompletableFuture<ExecuteToolResponse> executeToolResponse = client.async().tools().execute(params);

Or create an asynchronous client from the beginning:

importdev.arcade.client.ArcadeClientAsync;
importdev.arcade.client.okhttp.ArcadeOkHttpClientAsync;
importdev.arcade.models.tools.ExecuteToolRequest;
importdev.arcade.models.tools.ExecuteToolResponse;
importdev.arcade.models.tools.ToolExecuteParams;
importjava.util.concurrent.CompletableFuture;
// Configures using the `arcade.apiKey` and `arcade.baseUrl` system properties// Or configures using the `ARCADE_API_KEY` and `ARCADE_BASE_URL` environment variablesArcadeClientAsyncclient = ArcadeOkHttpClientAsync.fromEnv();
ExecuteToolRequestparams = ExecuteToolRequest.builder()
.toolName("tool_name")
.build();
CompletableFuture<ExecuteToolResponse> executeToolResponse = client.tools().execute(params);

The asynchronous client supports the same options as the synchronous one, except most methods return CompletableFutures.

Raw responses

The SDK defines methods that deserialize responses into instances of Java classes. However, these methods don't provide access to the response headers, status code, or the raw response body.

To access this data, prefix any HTTP method call on a client or service with withRawResponse():

importdev.arcade.core.http.Headers;
importdev.arcade.core.http.HttpResponseFor;
importdev.arcade.models.chat.ChatRequest;
importdev.arcade.models.chat.ChatResponse;
importdev.arcade.models.chat.completions.CompletionCreateParams;
ChatRequestparams = ChatRequest.builder().build();
HttpResponseFor<ChatResponse> chatResponse = client.chat().completions().withRawResponse().create(params);
intstatusCode = chatResponse.statusCode();
Headersheaders = chatResponse.headers();

You can still deserialize the response into an instance of a Java class if needed:

importdev.arcade.models.chat.ChatResponse;
ChatResponseparsedChatResponse = chatResponse.parse();

Error handling

The SDK throws custom unchecked exception types:

• ArcadeServiceException: Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:

  Status	Exception
  400	BadRequestException
  401	UnauthorizedException
  403	PermissionDeniedException
  404	NotFoundException
  422	UnprocessableEntityException
  429	RateLimitException
  5xx	InternalServerException
  others	UnexpectedStatusCodeException

• ArcadeIoException: I/O networking errors.

• ArcadeRetryableException: Generic error indicating a failure that could be retried by the client.

• ArcadeInvalidDataException: Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.

• ArcadeException: Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.

Pagination

The SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.

Auto-pagination

To iterate through all results across all pages, use the autoPager() method, which automatically fetches more pages as needed.

When using the synchronous client, the method returns an Iterable

importdev.arcade.models.admin.userconnections.UserConnectionListPage;
importdev.arcade.models.admin.userconnections.UserConnectionResponse;
UserConnectionListPagepage = client.admin().userConnections().list();
// Process as an Iterablefor (UserConnectionResponseuserConnection : page.autoPager()) {
System.out.println(userConnection);
}
// Process as a Streampage.autoPager()
.stream()
.limit(50)
.forEach(userConnection -> System.out.println(userConnection));

When using the asynchronous client, the method returns an AsyncStreamResponse:

importdev.arcade.core.http.AsyncStreamResponse;
importdev.arcade.models.admin.userconnections.UserConnectionListPageAsync;
importdev.arcade.models.admin.userconnections.UserConnectionResponse;
importjava.util.Optional;
importjava.util.concurrent.CompletableFuture;
CompletableFuture<UserConnectionListPageAsync> pageFuture = client.async().admin().userConnections().list();
pageFuture.thenRun(page -> page.autoPager().subscribe(userConnection -> {
System.out.println(userConnection);
}));
// If you need to handle errors or completion of the streampageFuture.thenRun(page -> page.autoPager().subscribe(newAsyncStreamResponse.Handler<>() {
@OverridepublicvoidonNext(UserConnectionResponseuserConnection) {
System.out.println(userConnection);
}
@OverridepublicvoidonComplete(Optional<Throwable> error) {
if (error.isPresent()) {
System.out.println("Something went wrong!");
thrownewRuntimeException(error.get());
} else {
System.out.println("No more!");
}
}
}));
// Or use futurespageFuture.thenRun(page -> page.autoPager()
.subscribe(userConnection -> {
System.out.println(userConnection);
})
.onCompleteFuture()
.whenComplete((unused, error) -> {
if (error != null) {
System.out.println("Something went wrong!");
thrownewRuntimeException(error);
} else {
System.out.println("No more!");
}
}));

Manual pagination

To access individual page items and manually request the next page, use the items(), hasNextPage(), and nextPage() methods:

importdev.arcade.models.admin.userconnections.UserConnectionListPage;
importdev.arcade.models.admin.userconnections.UserConnectionResponse;
UserConnectionListPagepage = client.admin().userConnections().list();
while (true) {
for (UserConnectionResponseuserConnection : page.items()) {
System.out.println(userConnection);
}
if (!page.hasNextPage()) {
break;
}
page = page.nextPage();
}

Logging

The SDK uses the standard OkHttp logging interceptor.

Enable logging by setting the ARCADE_LOG environment variable to info:

export ARCADE_LOG=info

Or to debug for more verbose logging:

export ARCADE_LOG=debug

ProGuard and R8

Although the SDK uses reflection, it is still usable with ProGuard and R8 because arcade-java-core is published with a configuration file containing keep rules.

ProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.

Jackson

The SDK depends on Jackson for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.

The 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).

If the SDK threw an exception, but you're certain the version is compatible, then disable the version check using the checkJacksonVersionCompatibility on ArcadeOkHttpClient or ArcadeOkHttpClientAsync.

Caution

We make no guarantee that the SDK works correctly when the Jackson version check is disabled.

Also note that there are bugs in older Jackson versions that can affect the SDK. We don't work around all Jackson bugs (example) and expect users to upgrade Jackson for those instead.

Network options

Retries

The SDK automatically retries 2 times by default, with a short exponential backoff between requests.

Only the following error types are retried:

• Connection errors (for example, due to a network connectivity problem)
• 408 Request Timeout
• 409 Conflict
• 429 Rate Limit
• 5xx Internal

The API may also explicitly instruct the SDK to retry or not retry a request.

To set a custom number of retries, configure the client using the maxRetries method:

importdev.arcade.client.ArcadeClient;
importdev.arcade.client.okhttp.ArcadeOkHttpClient;
ArcadeClientclient = ArcadeOkHttpClient.builder()
.fromEnv()
.maxRetries(4)
.build();

Timeouts

Requests time out after 1 minute by default.

To set a custom timeout, configure the method call using the timeout method:

importdev.arcade.models.chat.ChatResponse;
ChatResponsechatResponse = client.chat().completions().create(
params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
);

Or configure the default for all method calls at the client level:

importdev.arcade.client.ArcadeClient;
importdev.arcade.client.okhttp.ArcadeOkHttpClient;
importjava.time.Duration;
ArcadeClientclient = ArcadeOkHttpClient.builder()
.fromEnv()
.timeout(Duration.ofSeconds(30))
.build();

Proxies

To route requests through a proxy, configure the client using the proxy method:

importdev.arcade.client.ArcadeClient;
importdev.arcade.client.okhttp.ArcadeOkHttpClient;
importjava.net.InetSocketAddress;
importjava.net.Proxy;
ArcadeClientclient = ArcadeOkHttpClient.builder()
.fromEnv()
.proxy(newProxy(
Proxy.Type.HTTP, newInetSocketAddress(
"https://example.com", 8080
)
))
.build();

Connection pooling

To customize the underlying OkHttp connection pool, configure the client using the maxIdleConnections and keepAliveDuration methods:

importdev.arcade.client.ArcadeClient;
importdev.arcade.client.okhttp.ArcadeOkHttpClient;
importjava.time.Duration;
ArcadeClientclient = ArcadeOkHttpClient.builder()
.fromEnv()
// If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.
.maxIdleConnections(10)
.keepAliveDuration(Duration.ofMinutes(2))
.build();

If both options are unset, OkHttp's default connection pool settings are used.

HTTPS

Note

Most applications should not call these methods, and instead use the system defaults. The defaults include special optimizations that can be lost if the implementations are modified.

To configure how HTTPS connections are secured, configure the client using the sslSocketFactory, trustManager, and hostnameVerifier methods:

importdev.arcade.client.ArcadeClient;
importdev.arcade.client.okhttp.ArcadeOkHttpClient;
ArcadeClientclient = ArcadeOkHttpClient.builder()
.fromEnv()
// If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.
.sslSocketFactory(yourSSLSocketFactory)
.trustManager(yourTrustManager)
.hostnameVerifier(yourHostnameVerifier)
.build();

Custom HTTP client

The SDK consists of three artifacts:

• arcade-java-core
  • Contains core SDK logic
  • Does not depend on OkHttp
  • Exposes ArcadeClient, ArcadeClientAsync, ArcadeClientImpl, and ArcadeClientAsyncImpl, all of which can work with any HTTP client
• arcade-java-client-okhttp
  • Depends on OkHttp
  • Exposes ArcadeOkHttpClient and ArcadeOkHttpClientAsync, which provide a way to construct ArcadeClientImpl and ArcadeClientAsyncImpl, respectively, using OkHttp
• arcade-java
  • Depends on and exposes the APIs of both arcade-java-core and arcade-java-client-okhttp
  • Does not have its own logic

This structure allows replacing the SDK's default HTTP client without pulling in unnecessary dependencies.

Customized OkHttpClient

Tip

Try the available network options before replacing the default client.

To use a customized OkHttpClient:

1. Replace your arcade-java dependency with arcade-java-core
2. Copy arcade-java-client-okhttp's OkHttpClient class into your code and customize it
3. Construct ArcadeClientImpl or ArcadeClientAsyncImpl, similarly to ArcadeOkHttpClient or ArcadeOkHttpClientAsync, using your customized client

Completely custom HTTP client

To use a completely custom HTTP client:

1. Replace your arcade-java dependency with arcade-java-core
2. Write a class that implements the HttpClient interface
3. Construct ArcadeClientImpl or ArcadeClientAsyncImpl, similarly to ArcadeOkHttpClient or ArcadeOkHttpClientAsync, using your new client class

Undocumented API functionality

The SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.

Parameters

To set undocumented parameters, call the putAdditionalHeader, putAdditionalQueryParam, or putAdditionalBodyProperty methods on any Params class:

importdev.arcade.core.JsonValue;
importdev.arcade.models.tools.ToolExecuteParams;
ToolExecuteParamsparams = ToolExecuteParams.builder()
.putAdditionalHeader("Secret-Header", "42")
.putAdditionalQueryParam("secret_query_param", "42")
.putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))
.build();

These can be accessed on the built object later using the _additionalHeaders(), _additionalQueryParams(), and _additionalBodyProperties() methods.

To set a documented parameter or property to an undocumented or not yet supported value, pass a JsonValue object to its setter:

importdev.arcade.models.tools.ExecuteToolRequest;
importdev.arcade.models.tools.ToolExecuteParams;
ToolExecuteParamsparams = ToolExecuteParams.builder()
.executeToolRequest(ExecuteToolRequest.builder()
.toolName("tool_name")
.build())
.build();

The most straightforward way to create a JsonValue is using its from(...) method:

importdev.arcade.core.JsonValue;
importjava.util.List;
importjava.util.Map;
// Create primitive JSON valuesJsonValuenullValue = JsonValue.from(null);
JsonValuebooleanValue = JsonValue.from(true);
JsonValuenumberValue = JsonValue.from(42);
JsonValuestringValue = JsonValue.from("Hello World!");
// Create a JSON array value equivalent to `["Hello", "World"]`JsonValuearrayValue = JsonValue.from(List.of(
"Hello", "World"
));
// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`JsonValueobjectValue = JsonValue.from(Map.of(
"a", 1,
"b", 2
));
// Create an arbitrarily nested JSON equivalent to:// {// "a": [1, 2],// "b": [3, 4]// }JsonValuecomplexValue = JsonValue.from(Map.of(
"a", List.of(
1, 2
),
"b", List.of(
3, 4
)
));

Normally a Builder class's build method will throw IllegalStateException if any required parameter or property is unset.

To forcibly omit a required parameter or property, pass JsonMissing:

importdev.arcade.core.JsonMissing;
importdev.arcade.models.tools.ExecuteToolRequest;
importdev.arcade.models.tools.ToolExecuteParams;
ToolExecuteParamsparams = ToolExecuteParams.builder()
.executeToolRequest(ExecuteToolRequest.builder()
.toolName("tool_name")
.build())
.toolName(JsonMissing.of())
.build();

Response properties

To access undocumented response properties, call the _additionalProperties() method:

importdev.arcade.core.JsonValue;
importjava.util.Map;
Map<String, JsonValue> additionalProperties = client.tools().execute(params)._additionalProperties();
JsonValuesecretPropertyValue = additionalProperties.get("secretProperty");
Stringresult = secretPropertyValue.accept(newJsonValue.Visitor<>() {
@OverridepublicStringvisitNull() {
return"It's null!";
}
@OverridepublicStringvisitBoolean(booleanvalue) {
return"It's a boolean!";
}
@OverridepublicStringvisitNumber(Numbervalue) {
return"It's a number!";
}
// Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`// The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden
});

To access a property's raw JSON value, which may be undocumented, call its _ prefixed method:

importdev.arcade.core.JsonField;
importjava.util.Optional;
JsonField<Object> field = client.tools().execute(params)._field();
if (field.isMissing()) {
// The property is absent from the JSON response
} elseif (field.isNull()) {
// The property was set to literal null
} else {
// Check if value was provided as a string// Other methods include `asNumber()`, `asBoolean()`, etc.Optional<String> jsonString = field.asString();
// Try to deserialize into a custom typeMyClassmyObject = field.asUnknown().orElseThrow().convert(MyClass.class);
}

Response validation

In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a String, but the API could return something else.

By default, the SDK will not throw an exception in this case. It will throw ArcadeInvalidDataException only if you directly access the property.

If you would prefer to check that the response is completely well-typed upfront, then either call validate():

importdev.arcade.models.tools.ExecuteToolResponse;
ExecuteToolResponseexecuteToolResponse = client.tools().execute(params).validate();

Or configure the method call to validate the response using the responseValidation method:

importdev.arcade.models.tools.ExecuteToolResponse;
ExecuteToolResponseexecuteToolResponse = client.tools().execute(
params, RequestOptions.builder().responseValidation(true).build()
);

Or configure the default for all method calls at the client level:

importdev.arcade.client.ArcadeClient;
importdev.arcade.client.okhttp.ArcadeOkHttpClient;
ArcadeClientclient = ArcadeOkHttpClient.builder()
.fromEnv()
.responseValidation(true)
.build();

Spring Boot Integration

The dev.arcade:arcade-spring-boot-starter provides a configured ArcadeClient bean if the following configuration values are set:

Spring Property	Environment variable	Required	Default value
arcade.api-key	ARCADE_API_KEY	true	-
arcade.base-url	ARCADE_BASE_URL	false	"https://api.arcade.dev"

Read the Spring Boot Externalized Configuration docs for more ways to configure these properties.

Run the examples

The examples in arcade-java-example can be run in your IDE or on the command line by running:

# Configure the environment variables export ARCADE_API_KEY="<your-api-key>"export ARCADE_USER_ID="arcade-userid-or-email"# run the example
./gradlew :arcade-java-example:run -Pexample=<example-name>

Example Name	Description
springboot.SpringBoot	Calls an aArcade tool using Spring Boot
springai.SpringAI	Allows a Spring AI chat client to call Arcade Tools, you must configure an OpenAI key for this example: export SPRING_AI_OPENAI_API_KEY=<your-open-ai-key>
Auth	Demos how to handle an OAuth authorization response
PlaySpotify	Calls an Arcade tool without a plain Java application.

Note

The above Spring Boot (and Spring AI) examples are not web applications, but the demonstrated logic will work the same way in a web app.

FAQ

Why don't you use plain enum classes?

Java enum classes are not trivially forwards compatible. Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.

Why do you represent fields using JsonField<T> instead of just plain T?

Using JsonField<T> enables a few features:

• Allowing usage of undocumented API functionality
• Lazily validating the API response against the expected shape
• Representing absent vs explicitly null values

Why don't you use data classes?

It is not backwards compatible to add new fields to a data class and we don't want to introduce a breaking change every time we add a field to a class.

Why don't you use checked exceptions?

Checked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.

Checked exceptions:

• Are verbose to handle
• Encourage error handling at the wrong level of abstraction, where nothing can be done about the error
• Are tedious to propagate due to the function coloring problem
• Don't play well with lambdas (also due to the function coloring problem)

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.