Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/iii-hq/sdk/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

  • Node.js 18.0.0 or higher
  • npm, yarn, or pnpm package manager

​
Install the SDK

Install the III SDK using your preferred package manager: 
npm install iii-sdk

​
Package Information

The III SDK is published as iii-sdk and provides both ESM and CommonJS exports:
  • Main export: Core SDK functionality
  • Subpath exports:
    • iii-sdk/stream - Stream interfaces
    • iii-sdk/state - State management
    • iii-sdk/telemetry - OpenTelemetry utilities

​
Dependencies

The SDK includes built-in support for:
  • OpenTelemetry: Automatic distributed tracing, metrics, and logging
  • WebSocket: Persistent connection to the III Engine
  • W3C Trace Context: Standard distributed tracing propagation

​
Verify Installation

Create a simple test file to verify the installation:
test.ts
import { init } from 'iii-sdk'

const iii = init('ws://localhost:49199')

iii.onConnectionStateChange((state) => {
  console.log('Connection state:', state)
})
Run the file: 
node test.ts
You should see the connection state change to connected if the III Engine is running.

​
Next Steps

Quickstart

Get started with your first III function

API Reference

Explore the complete API documentation

Build docs developers (and LLMs) love

Get started for freeTalk to us