Easy installation and setup of the Java SDK.


The SDK is mostly generated from the OpenAPI specification. You can read the API documentation here:

This means that the API is fully covered, including all endpoints used by the frontend. You can also use the SDK to create and configure Apps, schemas and rules.

Use this SDK in your Java application to integrate with Squidex CMS.

Install the SDK

The SDK is available on Maven. The installation depends on your build system.


Add the dependency in your build.gradle:

dependencies {
    implementation 'io.squidex:squidex:1.0.0'


Add the dependency in your pom.xml:

</dependency>// Some code

Instantiate the SDK

The SquidexClient is the main entry point for the SDK. It provides the properties for all endpoints.

You can instantiate the client using the following code snippet:

SquidexClient squidex = SquidexClient.builder()

The url parameter is optional if you are using Squidex Cloud.

Additional Configuration

In this article, we will cover some of the important configuration values only. The client is based on the OkHttp library to support all platforms including Android. Therefore many configuration options are available throug passing a custom client to Squidex. This client gets cloned to make customizations, for example for authentication.


Configure a timeout in seconds to cancel unresponsive requests.

OkHttpClient client = new OkHttpClient.Builder()
    .connectTimeout(10, TimeUnit.SECONDS)
    .writeTimeout(10, TimeUnit.SECONDS)
    .readTimeout(30, TimeUnit.SECONDS)
SquidexClient squidex = SquidexClient.builder()

The default timeout is 30 seconds.

Read more:

Token Store

The SDK uses the client ID and the client secret to acquire a bearer token, and handles invalidation and expiration automatically. By default the token is stored inside the client and therefore a new token is acquired when the client is cleaned by the garbage collector. However, one can define where the token is stored.

SquidexClient squidex = SquidexClient.builder()
    .tokenStore(new MyTokenStore())

Ignore Certificates

By default the certificates are validated. But for test environments it might be necessary to connect to instances with self signed certificates only. Therefore we have introduced an option to ignore the certificate chain:

SquidexClient squidex = SquidexClient.builder()

Use the Client

To use the client you have to use the correct property.

For example, to create a schema use the schemas property.

CreateSchemaDto request = CreateSchemaDto.builder()

SchemaDto createdSchema = client.schemas().postSchema(request);

In order to work with contents, use the contents property.

Map<String, Map<String, Object>> dataItem = new HashMap<>();
Map<String, Object> dataField = new HashMap<>();
dataItem.put("field1", dataField);
dataField.put("iv", id);

ContentsPostContentRequest request = ContentsPostContentRequest.builder()
client.contents().postContent(schema.getName(), request);

Error Handling

The SDK uses exceptions for error handling.

Refer to the code snippet below for an example:

try {
} catch (ApiError ex) {
    if (ex.statusCode() == 400) {
        System.out.println("App probably already exists.");
    } else {
        throw ex;


As of this writing, the SDK has the following limitations:

  1. Endpoints to download files (e.g. assets) return a stream only and not metadata information like the content type or the content length.

  2. Endpoints to download files work for Node only and are not available in the browser. This is generally not an issue as assets are handled via direct links in the browser.

  3. The generated builders all follow the staged builder pattern. For untyped data, e.g. content items the builder is not available yet and you have to construct the data structure manually using hash maps and arrays.

  4. Deprecated methods and properties are not annotated yet.

Last updated