Docs
Contents

Integration installation

This page uses the published 2.12.0 SDKs. Install the six npm coordinates from their remote registries. Download and verify the six Java / Python / Go Server and Console ZIPs from the matching Release. Package publication and service deployment are separate facts; the package version does not establish feature availability in a target environment.

From 2.7.0 the JS packages are renamed: appbase-web-sdk / appbase-node-sdk / appbase-console-sdk → agentbase-web-sdk / agentbase-node-sdk / agentbase-console-sdk, with the version system unified to the service version number (2.7.x). The old package names remain on the 2.6 line on the registry (appbase-web-sdk@22.8.0 etc.); do not mix the two sets of package names in new iterations.

Version facts (npm 2.12.0 / ZIP v2.12.0, canonical)

ItemExact value
Service version2.12.0 (release-2.12.0 tip APP_VERSION_STABLE = 2.12.0, single self-bump from 2.9.0)
Project metadata database migrationV61 (determined by the service version; cannot be inferred from npm / Python package versions)
Web SDK(npm)agentbase-web-sdk@2.12.0
Node Server SDK(npm)agentbase-node-sdk@2.12.0
Console SDK (npm, JS management surface)agentbase-console-sdk@2.12.0
Java Server SDKio.agentbase:agentbase-java-sdk:2.12.0 (ZIP delivery package, v2.12.0 release terminal state)
Java Console SDKio.agentbase.console:agentbase-console-java-sdk:2.12.0 (ZIP delivery package, same as above)
Python Server SDKagentbase-python-sdk 2.12.0 (wheel + sdist ZIP, offline install)
Python Console SDKagentbase-console-python-sdk 2.12.0 (wheel + sdist ZIP, offline install)
Go Server SDKmodule agentbase-go-sdk (module source ZIP, consumed by replace)
Go Console SDKmodule agentbase-console-go-sdk (module source ZIP, consumed by replace)
Java SDK compatibilityJava 11 source/target (classfile major 55), runnable on OpenJDK 11 / 17

The six non-npm ZIP artifacts (Server + Console for Java / Python / Go) are hosted in release <https://code.alipay.com/obai/agentbase-sdks/releases/v2.12.0> (including the outer SHA256SUMS). The Release process for Java / Python / Go only builds and verifies artifacts; it does not publish to the Maven registry, PyPI, or the public Go module proxy; Python requires Python 3.9+ (depending on requests and pydantic>=2,<3), and Go requires go 1.22.5+ (the SDK has zero third-party dependencies).

Path one: npm remote registry installation (Web / Node / Console)

The three JS packages are installed from the remote npm registry with exact pinned versions, never using floating ranges (^, ~) or alternative package names:

npm install agentbase-web-sdk@2.12.0 --save-exact       # Browser frontend (user Session)
npm install agentbase-node-sdk@2.12.0 --save-exact      # Node.js backend / admin scripts (API Key)
npm install agentbase-console-sdk@2.12.0 --save-exact   # Console management-plane automation (Console Session / JWT)

For initialization differences across packages and the feature-surface mapping, see client-sdk/web.md, server-sdk/nodejs.md, console-sdk/nodejs.md, and the "SDK category differences" section in each feature's documentation.

import { Client, Account } from 'agentbase-web-sdk';

const client = new Client()
    .setEndpoint('https://<host>/v1')
    .setProject('<PROJECT_ID>');
const account = new Account(client);

For initialization differences across packages and the feature-surface mapping, see server-sdk/nodejs.md, console-sdk/nodejs.md, and the "SDK category differences" section in each feature's documentation; for Java / Python / Go installation see below and the per-language pages.

Internal npm uses the same exact versions; the publish targets are https://registry.anpm.alibaba-inc.com (subject to the actual configuration of the publish script):

npm install @alipay/agentbase-web-sdk@2.12.0 --save-exact --registry=https://registry.anpm.alibaba-inc.com
npm install @alipay/agentbase-node-sdk@2.12.0 --save-exact --registry=https://registry.anpm.alibaba-inc.com
npm install @alipay/agentbase-console-sdk@2.12.0 --save-exact --registry=https://registry.anpm.alibaba-inc.com

Both the public and internal six coordinates were read back from the registry, and the release-2.12.0 tag points to 2.12.0; see the repository's automation/release-evidence/2.12.0.json for the release manifest and digests. Installation still pins exact versions and does not rely on movable tag resolution.

Path Two: Non-npm Artifact Installation (Java / Python / Go ZIP Download and Verification)

The v2.12.0 Release provides six ZIP artifacts plus an outer SHA256SUMS:

ArtifactContents
agentbase-java-sdk-2.12.0.zipJava Server: JAR + POM + runtime dependencies (lib/) + inner SHA256SUMS
agentbase-console-java-sdk-2.12.0.zipJava Console: same as above
agentbase-python-sdk-2.12.0.zipPython Server: sdist + wheel + inner SHA256SUMS
agentbase-console-python-sdk-2.12.0.zipPython Console: same as above
agentbase-go-sdk-2.12.0.zipGo Server: module source tree + inner SHA256SUMS
agentbase-console-go-sdk-2.12.0.zipGo Console: same as above

The Java ZIP is an outer distribution container of "JAR + POM + runtime dependencies (lib/) + two-layer SHA-256 verification". Console SDK sources and its own JAR are pure Java; the HTTP transport uses OkHttp 5, and the runtime dependencies include the Kotlin standard library — when using the JAR directly, the lib/ dependency must be distributed along with it.

1. Download and two-layer verification

BUNDLE_DIR="$(mktemp -d)"
BASE_URL="https://code.alipay.com/obai/agentbase-sdks/releases/download/v2.12.0"

# Download six ZIPs on demand (the example below shows two for Java)
curl -fsSL -o "$BUNDLE_DIR/agentbase-java-sdk-2.12.0.zip" "$BASE_URL/agentbase-java-sdk-2.12.0.zip"
curl -fsSL -o "$BUNDLE_DIR/agentbase-console-java-sdk-2.12.0.zip" "$BASE_URL/agentbase-console-java-sdk-2.12.0.zip"
# Validate files (outer layer)
curl -fsSL -o "$BUNDLE_DIR/SHA256SUMS" "$BASE_URL/SHA256SUMS"

(cd "$BUNDLE_DIR" && sha256sum -c --ignore-missing SHA256SUMS)   # Outer validation
unzip "$BUNDLE_DIR/agentbase-java-sdk-2.12.0.zip" -d "$BUNDLE_DIR"
unzip "$BUNDLE_DIR/agentbase-console-java-sdk-2.12.0.zip" -d "$BUNDLE_DIR"
(cd "$BUNDLE_DIR/agentbase-java-sdk-2.12.0" && sha256sum -c SHA256SUMS)             # Inner validation
(cd "$BUNDLE_DIR/agentbase-console-java-sdk-2.12.0" && sha256sum -c SHA256SUMS)

Downloading and verification for Python / Go are analogous (substituting the corresponding ZIP name); for installation see examples/python.md and examples/go.md.

2. Java: Install into a local Maven repository (preferred for long-term maintained projects)

mvn install:install-file \
  -Dfile="$BUNDLE_DIR/agentbase-java-sdk-2.12.0/agentbase-java-sdk-2.12.0.jar" \
  -DpomFile="$BUNDLE_DIR/agentbase-java-sdk-2.12.0/agentbase-java-sdk-2.12.0.pom"

mvn install:install-file \
  -Dfile="$BUNDLE_DIR/agentbase-console-java-sdk-2.12.0/agentbase-console-java-sdk-2.12.0.jar" \
  -DpomFile="$BUNDLE_DIR/agentbase-console-java-sdk-2.12.0/agentbase-console-java-sdk-2.12.0.pom"

Declare the dependency in your application (the two Client have the same name but independent namespaces: io.agentbase.Client and io.agentbase.console.Client; import only one per Java file and use the fully qualified class name for the other):

<dependency>
  <groupId>io.agentbase</groupId>
  <artifactId>agentbase-java-sdk</artifactId>
  <version>2.12.0</version>
</dependency>

3. Java: Use the SDK JAR directly (controlled scripts / offline environments)

mkdir -p /path/to/tool/lib
cp "$BUNDLE_DIR/agentbase-java-sdk-2.12.0/agentbase-java-sdk-2.12.0.jar" /path/to/tool/lib/
cp "$BUNDLE_DIR/agentbase-java-sdk-2.12.0/lib/"*.jar /path/to/tool/lib/

javac --release 11 -cp "lib/*" -d out src/main/java/Tool.java
java -cp "out:lib/*" Tool        # On Windows the classpath separator is ;

Defer to the actual contents of lib/ in the extracted directory; after upgrading artifacts, do not reuse the old dependency list. Direct JAR usage does not manage transitive dependencies or conflicts; prefer Maven for long-running services.

Post-installation Checklist