API Reference

This section provides comprehensive documentation for all classes, types, and functions in the Droid SDK.

Core Classes

Class	Description
Droid	Main entry point for the SDK
Thread	Multi-turn conversation management
TurnResult	Execution result wrapper

Quick Reference

Creating a Droid Instance

import { Droid, MODELS } from '@activade/droid-sdk';

const droid = new Droid({
  model: MODELS.CLAUDE_SONNET,
  autonomyLevel: 'high',
  reasoningEffort: 'medium',
  cwd: '/path/to/project',
  timeout: 600000
});

Configuration Options

Option	Type	Default	Description
model	ModelId | string	-	AI model to use
autonomyLevel	'default' | 'low' | 'medium' | 'high'	'default'	Autonomous decision level
reasoningEffort	'off' | 'none' | 'low' | 'medium' | 'high'	-	Reasoning intensity
cwd	string	process.cwd()	Working directory
timeout	number	600000	Timeout in milliseconds
droidPath	string	'droid'	Path to CLI binary

Available Models

import { MODELS } from '@activade/droid-sdk';

// Anthropic
MODELS.CLAUDE_OPUS    // claude-opus-4-5-20251101
MODELS.CLAUDE_SONNET  // claude-sonnet-4-5-20250929
MODELS.CLAUDE_HAIKU   // claude-haiku-4-5-20251001

// OpenAI
MODELS.GPT_5_1        // gpt-5.1
MODELS.GPT_5_1_CODEX  // gpt-5.1-codex
MODELS.GPT_5_2        // gpt-5.2

// Google
MODELS.GEMINI_3_PRO   // gemini-3-pro-preview
MODELS.GEMINI_3_FLASH // gemini-3-flash-preview

// Open Source
MODELS.DROID_CORE     // glm-4.6

Error Classes

Error	Description
DroidError	Base class for all SDK errors
CliNotFoundError	CLI binary not found
ExecutionError	CLI execution failed
ParseError	JSON parsing failed
TimeoutError	Operation timed out
StreamError	Stream reading failed

Event Types

Event Type	Description
system	System initialization
message	User or assistant message
tool_call	Tool invocation
tool_result	Tool result
completion	Turn completed
turn.failed	Turn failed

Import Patterns

// Main SDK
import { Droid, Thread, TurnResult, MODELS } from '@activade/droid-sdk';

// Error classes
import {
  DroidError,
  CliNotFoundError,
  ExecutionError,
  ParseError,
  TimeoutError,
  StreamError
} from '@activade/droid-sdk';

// Event types and guards
import {
  isToolCallEvent,
  isToolResultEvent,
  isMessageEvent,
  type StreamEvent,
  type ToolCallEvent
} from '@activade/droid-sdk';

// CLI utilities (separate entry point)
import { ensureDroidCli, isDroidCliInstalled } from '@activade/droid-sdk/cli';

// Model utilities
import { getModelInfo, isValidModel, MODEL_INFO } from '@activade/droid-sdk';