Llama Cloud Admin Java API Library

The Llama Cloud Admin Java SDK provides convenient access to the Llama Cloud Admin REST API from applications written in Java.

It is generated with Stainless.

This SDK covers the LlamaCloud organization- and project-administration API — 30 endpoints in total: organizations (client.organizations()), organization members and roles (client.organizations().users(), client.organizations().roles()), projects (client.projects()), invites (client.invites()), and the deployment-operator surface under /api/v1/admin/* (client.admin()). These endpoints are not covered by the public documentation on developers.llamaindex.ai. For the full method surface, generate the Javadoc with ./gradlew :llama-cloud-admin:dokkaJavadoc, or read the service interfaces under llama-cloud-admin-core/src/main/kotlin/ai/llamaindex/llamacloudadmin/services/blocking/.

Installation

This SDK is not published to Maven Central. Build it from source and install it into your local Maven repository (~/.m2/repository):

git clone https://github.com/run-llama/llamacloud-admin-java.git
cd llamacloud-admin-java
./gradlew publishToMavenLocal

Building requires JDK 21. The artifacts it produces target Java 8. 0.0.1 is a fixed placeholder version that is never incremented — re-run publishToMavenLocal from the commit you want.

Gradle

repositories {
    mavenLocal()
    mavenCentral()
}

dependencies {
    implementation("ai.llamaindex:llama-cloud-admin:0.0.1")
}

Maven

Maven reads ~/.m2/repository by default, so no extra repository configuration is needed:

<dependency>
  <groupId>ai.llamaindex</groupId>
  <artifactId>llama-cloud-admin</artifactId>
  <version>0.0.1</version>
</dependency>

Requirements

This library requires Java 8 or later.

Usage

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationMember;
import ai.llamaindex.llamacloudadmin.models.organizations.users.UserListMembersParams;

// Configures using the `llamacloudadmin.llamaCloudApiKey` and `llamacloudadmin.baseUrl` system properties
// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_ADMIN_BASE_URL` environment variables
LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.fromEnv();

List<OrganizationMember> organizationMembers = client.organizations().users().listMembers("my-organization-id");

Client configuration

Configure the client using system properties or environment variables:

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;

// Configures using the `llamacloudadmin.llamaCloudApiKey` and `llamacloudadmin.baseUrl` system properties
// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_ADMIN_BASE_URL` environment variables
LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.fromEnv();

Or manually:

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;

LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.builder()
    .apiKey("My API Key")
    .build();

Or using a combination of the two approaches:

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;

LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.builder()
    // Configures using the `llamacloudadmin.llamaCloudApiKey` and `llamacloudadmin.baseUrl` system properties
    // Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_ADMIN_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`	`llamacloudadmin.llamaCloudApiKey`	`LLAMA_CLOUD_API_KEY`	true	-
`baseUrl`	`llamacloudadmin.baseUrl`	`LLAMA_CLOUD_ADMIN_BASE_URL`	false	`"https://api.cloud.llamaindex.ai"`

System properties take precedence over environment variables.

The API key must belong to an organization admin. The client.admin() methods (/api/v1/admin/*) additionally require the deployment's global admin key.

Self-hosted and BYOC deployments must set baseUrl (or LLAMA_CLOUD_ADMIN_BASE_URL) to their own host, and must use an API key belonging to that deployment's global admin.

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:

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;

LlamaCloudAdminClient clientWithOptions = client.withOptions(optionsBuilder -> {
    optionsBuilder.baseUrl("https://example.com");
    optionsBuilder.maxRetries(42);
});

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

Requests and responses

To send a request to the Llama Cloud Admin 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.organizations().users().listMembers(...) should be called with an instance of UserListMembersParams, and it will return an instance of List<OrganizationMember>.

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:

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationMember;
import ai.llamaindex.llamacloudadmin.models.organizations.users.UserListMembersParams;
import java.util.concurrent.CompletableFuture;

// Configures using the `llamacloudadmin.llamaCloudApiKey` and `llamacloudadmin.baseUrl` system properties
// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_ADMIN_BASE_URL` environment variables
LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.fromEnv();

CompletableFuture<List<OrganizationMember>> organizationMembers = client.async().organizations().users().listMembers("my-organization-id");

Or create an asynchronous client from the beginning:

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClientAsync;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClientAsync;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationMember;
import ai.llamaindex.llamacloudadmin.models.organizations.users.UserListMembersParams;
import java.util.concurrent.CompletableFuture;

// Configures using the `llamacloudadmin.llamaCloudApiKey` and `llamacloudadmin.baseUrl` system properties
// Or configures using the `LLAMA_CLOUD_API_KEY` and `LLAMA_CLOUD_ADMIN_BASE_URL` environment variables
LlamaCloudAdminClientAsync client = LlamaCloudAdminOkHttpClientAsync.fromEnv();

CompletableFuture<List<OrganizationMember>> organizationMembers = client.organizations().users().listMembers("my-organization-id");

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():

import ai.llamaindex.llamacloudadmin.core.http.Headers;
import ai.llamaindex.llamacloudadmin.core.http.HttpResponseFor;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationListPage;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationListParams;

HttpResponseFor<OrganizationListPage> page = client.organizations().withRawResponse().list();

int statusCode = page.statusCode();
Headers headers = page.headers();

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

import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationListPage;

OrganizationListPage parsedPage = page.parse();

Error handling

The SDK throws custom unchecked exception types:

LlamaCloudAdminServiceException: 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`

LlamaCloudAdminIoException: I/O networking errors.
LlamaCloudAdminRetryableException: Generic error indicating a failure that could be retried by the client.
LlamaCloudAdminInvalidDataException: 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.
LlamaCloudAdminException: 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

import ai.llamaindex.llamacloudadmin.models.organizations.Organization;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationListPage;

OrganizationListPage page = client.organizations().list();

// Process as an Iterable
for (Organization organization : page.autoPager()) {
    System.out.println(organization);
}

// Process as a Stream
page.autoPager()
    .stream()
    .limit(50)
    .forEach(organization -> System.out.println(organization));

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

import ai.llamaindex.llamacloudadmin.core.http.AsyncStreamResponse;
import ai.llamaindex.llamacloudadmin.models.organizations.Organization;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationListPageAsync;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;

CompletableFuture<OrganizationListPageAsync> pageFuture = client.async().organizations().list();

pageFuture.thenAccept(page -> page.autoPager().subscribe(organization -> {
    System.out.println(organization);
}));

// If you need to handle errors or completion of the stream
pageFuture.thenAccept(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {
    @Override
    public void onNext(Organization organization) {
        System.out.println(organization);
    }

    @Override
    public void onComplete(Optional<Throwable> error) {
        if (error.isPresent()) {
            System.out.println("Something went wrong!");
            throw new RuntimeException(error.get());
        } else {
            System.out.println("No more!");
        }
    }
}));

// Or use futures
pageFuture.thenAccept(page -> page.autoPager()
    .subscribe(organization -> {
        System.out.println(organization);
    })
    .onCompleteFuture()
    .whenComplete((unused, error) -> {
        if (error != null) {
            System.out.println("Something went wrong!");
            throw new RuntimeException(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:

import ai.llamaindex.llamacloudadmin.models.organizations.Organization;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationListPage;

OrganizationListPage page = client.organizations().list();
while (true) {
    for (Organization organization : page.items()) {
        System.out.println(organization);
    }

    if (!page.hasNextPage()) {
        break;
    }

    page = page.nextPage();
}

Logging

Enable logging by setting the LLAMA_CLOUD_ADMIN_LOG environment variable to info:

export LLAMA_CLOUD_ADMIN_LOG=info

Or to debug for more verbose logging:

export LLAMA_CLOUD_ADMIN_LOG=debug

Or configure the client manually using the logLevel method:

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import ai.llamaindex.llamacloudadmin.core.LogLevel;

LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.builder()
    .fromEnv()
    .logLevel(LogLevel.INFO)
    .build();

ProGuard and R8

Although the SDK uses reflection, it is still usable with ProGuard and R8 because llama-cloud-admin-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 LlamaCloudAdminOkHttpClient or LlamaCloudAdminOkHttpClientAsync.

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:

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;

LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.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:

import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationListPage;

OrganizationListPage page = client.organizations().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());

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

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import java.time.Duration;

LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.builder()
    .fromEnv()
    .timeout(Duration.ofSeconds(30))
    .build();

Proxies

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

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import java.net.InetSocketAddress;
import java.net.Proxy;

LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.builder()
    .fromEnv()
    .proxy(new Proxy(
      Proxy.Type.HTTP, new InetSocketAddress(
        "https://example.com", 8080
      )
    ))
    .build();

If the proxy responds with 407 Proxy Authentication Required, supply credentials by also configuring proxyAuthenticator:

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import ai.llamaindex.llamacloudadmin.core.http.ProxyAuthenticator;

LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.builder()
    .fromEnv()
    .proxy(...)
    // Or a custom implementation of `ProxyAuthenticator`.
    .proxyAuthenticator(ProxyAuthenticator.basic("username", "password"))
    .build();

Connection pooling

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

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import java.time.Duration;

LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.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:

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;

LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.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:

llama-cloud-admin-core
- Contains core SDK logic
- Does not depend on OkHttp
- Exposes LlamaCloudAdminClient, LlamaCloudAdminClientAsync, LlamaCloudAdminClientImpl, and LlamaCloudAdminClientAsyncImpl, all of which can work with any HTTP client
llama-cloud-admin-client-okhttp
- Depends on OkHttp
- Exposes LlamaCloudAdminOkHttpClient and LlamaCloudAdminOkHttpClientAsync, which provide a way to construct LlamaCloudAdminClientImpl and LlamaCloudAdminClientAsyncImpl, respectively, using OkHttp
llama-cloud-admin
- Depends on and exposes the APIs of both llama-cloud-admin-core and llama-cloud-admin-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:

Replace your llama-cloud-admin dependency with llama-cloud-admin-core
Copy llama-cloud-admin-client-okhttp's OkHttpClient class into your code and customize it
Construct LlamaCloudAdminClientImpl or LlamaCloudAdminClientAsyncImpl, similarly to LlamaCloudAdminOkHttpClient or LlamaCloudAdminOkHttpClientAsync, using your customized client

Completely custom HTTP client

To use a completely custom HTTP client:

Replace your llama-cloud-admin dependency with llama-cloud-admin-core
Write a class that implements the HttpClient interface
Construct LlamaCloudAdminClientImpl or LlamaCloudAdminClientAsyncImpl, similarly to LlamaCloudAdminOkHttpClient or LlamaCloudAdminOkHttpClientAsync, 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:

import ai.llamaindex.llamacloudadmin.core.JsonValue;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationCreateParams;

OrganizationCreateParams params = OrganizationCreateParams.builder()
    .name("My organization")
    .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 undocumented parameters on nested headers, query params, or body classes, call the putAdditionalProperty method on the nested class:

import ai.llamaindex.llamacloudadmin.core.JsonValue;
import ai.llamaindex.llamacloudadmin.models.admin.users.UserUpdateClaimsParams;

UserUpdateClaimsParams params = UserUpdateClaimsParams.builder()
    .setClaims(UserUpdateClaimsParams.SetClaims.builder()
        .putAdditionalProperty("secretProperty", JsonValue.from("42"))
        .build())
    .build();

These properties can be accessed on the nested built object later using the _additionalProperties() method.

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

import ai.llamaindex.llamacloudadmin.core.JsonValue;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationCreateParams;

OrganizationCreateParams params = OrganizationCreateParams.builder()
    .name(JsonValue.from(42))
    .build();

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

import ai.llamaindex.llamacloudadmin.core.JsonValue;
import java.util.List;
import java.util.Map;

// Create primitive JSON values
JsonValue nullValue = JsonValue.from(null);
JsonValue booleanValue = JsonValue.from(true);
JsonValue numberValue = JsonValue.from(42);
JsonValue stringValue = JsonValue.from("Hello World!");

// Create a JSON array value equivalent to `["Hello", "World"]`
JsonValue arrayValue = JsonValue.from(List.of(
  "Hello", "World"
));

// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`
JsonValue objectValue = JsonValue.from(Map.of(
  "a", 1,
  "b", 2
));

// Create an arbitrarily nested JSON equivalent to:
// {
//   "a": [1, 2],
//   "b": [3, 4]
// }
JsonValue complexValue = 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:

import ai.llamaindex.llamacloudadmin.core.JsonMissing;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationCreateParams;

OrganizationCreateParams params = OrganizationCreateParams.builder()
    .name(JsonMissing.of())
    .build();

Response properties

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

import ai.llamaindex.llamacloudadmin.core.JsonValue;
import java.util.Map;

Map<String, JsonValue> additionalProperties = client.organizations().create(params)._additionalProperties();
JsonValue secretPropertyValue = additionalProperties.get("secretProperty");

String result = secretPropertyValue.accept(new JsonValue.Visitor<>() {
    @Override
    public String visitNull() {
        return "It's null!";
    }

    @Override
    public String visitBoolean(boolean value) {
        return "It's a boolean!";
    }

    @Override
    public String visitNumber(Number value) {
        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:

import ai.llamaindex.llamacloudadmin.core.JsonField;
import java.util.Optional;

JsonField<String> name = client.organizations().create(params)._name();

if (name.isMissing()) {
  // The property is absent from the JSON response
} else if (name.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 = name.asString();

  // Try to deserialize into a custom type
  MyClass myObject = name.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 LlamaCloudAdminInvalidDataException only if you directly access the property.

Validating the response is not forwards compatible with new types from the API for existing fields.

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

import ai.llamaindex.llamacloudadmin.models.organizations.Organization;

Organization organization = client.organizations().create(params).validate();

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

import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationMember;

List<OrganizationMember> organizationMembers = client.organizations().users().listMembers("my-organization-id", RequestOptions.builder().responseValidation(true).build());

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

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;

LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.builder()
    .fromEnv()
    .responseValidation(true)
    .build();

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)

Versioning

This SDK has no published releases, git tags, or changelog, and the 0.0.1 version is a fixed placeholder. To get a reproducible build, check out a specific commit before building:

git checkout <commit-sha>
./gradlew publishToMavenLocal

Backwards-incompatible changes can land on the default branch.

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

Name		Name	Last commit message	Last commit date
Latest commit History 16 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
buildSrc		buildSrc
gradle/wrapper		gradle/wrapper
llama-cloud-admin-client-okhttp		llama-cloud-admin-client-okhttp
llama-cloud-admin-core		llama-cloud-admin-core
llama-cloud-admin-example		llama-cloud-admin-example
llama-cloud-admin-lib		llama-cloud-admin-lib
llama-cloud-admin-proguard-test		llama-cloud-admin-proguard-test
llama-cloud-admin		llama-cloud-admin
scripts		scripts
.gitattributes		.gitattributes
.gitignore		.gitignore
.stats.yml		.stats.yml
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
build.gradle.kts		build.gradle.kts
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
settings.gradle.kts		settings.gradle.kts

Uh oh!

Folders and files

Latest commit

History

Repository files navigation