SDK API Reference / ClaudeAgentClient
Class: ClaudeAgentClient
Claude Agent Client
Provides streaming chat with Claude Agent SDK, with session resumption support for multi-turn conversations.
Constructors
Constructor
new ClaudeAgentClient(
environment):ClaudeAgentClient
Parameters
environment
Returns
ClaudeAgentClient
Methods
chat()
chat(
message,sessionId?):AsyncGenerator<ClaudeAgentStreamEvent,void,unknown>
Send a message and stream the response using Claude Agent SDK V1
Parameters
message
string
The user message to send
sessionId?
string
Optional SDK session ID to resume a previous conversation
Returns
AsyncGenerator<ClaudeAgentStreamEvent, void, unknown>
chatStream()
chatStream(
messageGenerator,options?):AsyncGenerator<ClaudeAgentStreamEvent,void,unknown>
Stream a long-lived conversation using an AsyncGenerator of messages.
This enables:
- Persistent sessions without session resumption overhead
- Image/file attachments in messages
- Multiple messages in a single session
Parameters
messageGenerator
AsyncGenerator<StreamingInputMessage, void, unknown>
AsyncGenerator that yields user messages over time
options?
Optional configuration (maxTurns controls how many agent turns per message)
maxTurns?
number
Returns
AsyncGenerator<ClaudeAgentStreamEvent, void, unknown>
getQueryOptionsForDebug()
getQueryOptionsForDebug(): {
baseUrl:string;claudeCodePath:string;cwd:string;site:string; } |null
Get the query options that would be passed to the SDK (for debugging)
Returns
{ baseUrl: string; claudeCodePath: string; cwd: string; site: string; } | null
init()
init(
config):void
Initialize the client with configuration
Parameters
config
Returns
void
isInitialized()
isInitialized():
boolean
Check if client is initialized
Returns
boolean
setWorkingDirectory()
setWorkingDirectory(
dir):void
Update working directory
Parameters
dir
string
Returns
void