Skip to main content
These docs target Agentium 4.0.0. Use Node.js 22.18+ within v22 or 24.11+ within v24, with TypeScript in ESM mode. Install only the packages and provider SDKs your application uses.

​
Set up your environment

Use "type": "module" in your application’s package.json. New applications can use the CLI project tutorial; existing applications can follow the manual quickstart.
Keep credentials in the server environment. The tutorials read OPENAI_API_KEY and allow OPENAI_MODEL to override the documented default. Setting environment variables alone does not load a .env file; use your host’s environment loader if needed.

​
Add a package

Keep Agentium packages on matching versions. Install the harness as its own package alongside core:
For an Express application:
See the package directory for all ten packages and the harness quickstart for a provider-free first run.

​
Optional dependencies

Provider, database, browser, telephony, and queue SDKs are optional integration dependencies. An unrelated capability should not require installing all of them.

​
Build a matching local checkout

For SDK development or an unpublished patch, build all required packages from the same revision:
Install those tarballs in your application, replacing the absolute paths:
Use the version in your checkout’s package manifests when building a later revision. Local packages can share a release’s version string while containing different changes; keep the source revision with your test results.

​
Upgrade from 3.x

Read the v4 migration guide before changing dependencies. V4 removes Agent-owned harness entrypoints and redundant protocol aliases, makes workspace and hosting modes explicit, and changes several integration contracts. Persistent queue metadata may need migration before upgrading BullMQ. If your registry cannot resolve 4.0.0, check that it is using the intended public registry or that your private mirror has received the release. Do not silently substitute a 3.x package for a v4 example.