Installation
Install the Agent OTP SDK in your project using your preferred package manager.
Requirements
- Node.js 18.0 or later
- TypeScript 5.0 or later (recommended)
Package Managers
npm
npm install @orrisai/agent-otp-sdkyarn
yarn add @orrisai/agent-otp-sdkpnpm
pnpm add @orrisai/agent-otp-sdkbun
bun add @orrisai/agent-otp-sdkPython SDK
For Python projects, install the Python SDK using pip:
pip install agent-otpSee the Python SDK documentation for more details.
Peer Dependencies
The TypeScript SDK has no required peer dependencies. It works in both Node.js and browser environments.
TypeScript Configuration
If you're using TypeScript, ensure your tsconfig.json includes the following settings for optimal type inference:
{
"compilerOptions": {
"strict": true,
"moduleResolution": "bundler",
"esModuleInterop": true
}
}CDN Usage
For quick prototyping, you can load the SDK from a CDN:
<script type="module">
import { AgentOTPClient } from 'https://esm.sh/@orrisai/agent-otp-sdk';
const client = new AgentOTPClient({ apiKey: 'your-api-key' });
</script>Note: CDN usage is only recommended for development and prototyping. For production, always use a package manager.
Verifying Installation
To verify the SDK is installed correctly, run this quick test:
import { AgentOTPClient } from '@orrisai/agent-otp-sdk';
const client = new AgentOTPClient({
apiKey: 'test-key',
});
console.log('SDK installed successfully!');
console.log('Version:', client.version);