The AI Agent provider exposes several methods.
Core methods
| Method | Description | Parameters |
|---|
run() | Starts a new AI Agent lifecycle | None |
stop() | Stops the current AI Agent lifecycle | None |
reset(chatMessages?) | Resets the AI Agent provider to its initial state | chatMessages?: ChatMessage[] |
setSystemPrompt(systemPrompt) | Sets the system prompt | systemPrompt: string | null |
Conversation management
| Method | Description | Parameters |
|---|
addUserMessage(message, options?) | Adds a user message to the conversation | message: string, options?: AddUserMessageOptions |
addChatMessages(messages) | Adds multiple chat messages to the conversation | messages: ChatMessage[] |
setChatMessages(messages) | Replaces all messages in the conversation | messages: ChatMessage[] |
setAutoAccept(autoAccept) | Changes the auto-accept setting | autoAccept: "always" | "never" | "onlyRead" |
setCheckpoint() | Saves the current state as a checkpoint | None |
restoreCheckpoint(checkpoint) | Restores a previously saved checkpoint | checkpoint: Checkpoint |
| Method | Description | Parameters |
|---|
acceptToolCall() | Accepts the pending tool call | None |
rejectToolCall() | Rejects the pending tool call | None |