API 参考
Use the conceptual documentation to choose an integration path, then open the rendered Javadoc for exact Java types and method signatures. The links below point to the published 2.4.2 Javadoc, not the repository's next snapshot.
Rendered Javadoc by module
| Area | Maven artifact | Versioned HTML API |
|---|---|---|
| Models, Tools, Skills, MCP, RAG | ai4j | Open ai4j 2.4.2 Javadoc |
| Generic Agent runtime | ai4j-agent | Open ai4j-agent 2.4.2 Javadoc |
| Coding Agent runtime | ai4j-coding | Open ai4j-coding 2.4.2 Javadoc |
| CLI, TUI, and ACP host | ai4j-cli | Open ai4j-cli 2.4.2 Javadoc |
| Extension and plugin contracts | ai4j-extension-api | Open ai4j-extension-api 2.4.2 Javadoc |
These are browser-rendered API pages, so package navigation, search, inherited members, and linked types work without downloading and unpacking a Javadoc JAR.
Choose the right reference
- Start with Core SDK for normal model calls, Tools, Skills, MCP, and RAG.
- Start with Agent Runtime for orchestration, memory, and permission boundaries.
- Start with Coding Agent for CLI, workspace, session, and ACP integration.
- Start with Extensions before depending on an extension or plugin SPI.
The guides explain behavior and design boundaries. Javadoc is the source for Java signatures, overloads, annotations, and package-level types.
Version navigation
The explicit 2.4.2 URLs make the reference reproducible for a released dependency. To browse a module's published versions, remove the version segment from the corresponding javadoc.io URL, for example ai4j versions.
The repository currently develops the next 2.4.3-SNAPSHOT; snapshots are not release API documentation. Use 版本兼容性 before upgrading, and use the release and artifacts guide to align a multi-module build with the BOM.