Skip to content

docs(extensions): clarify streaming state for sendMessage parameters #1687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
westhood wants to merge 1 commit into from
+3 −1
Closed

docs(extensions): clarify streaming state for sendMessage parameters #1687

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/coding-agent/docs/extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -925,12 +925,14 @@ pi.sendMessage({
});
```

**Note on streaming:** The agent has two states: streaming (actively processing a turn with tool calls) and idle (waiting for input). The `deliverAs` and `triggerTurn` options behave differently depending on this state.

**Options:**
- `deliverAs` - Delivery mode:
- `"steer"` (default) - Interrupts streaming. Delivered after current tool finishes, remaining tools skipped.
- `"followUp"` - Waits for agent to finish. Delivered only when agent has no more tool calls.
- `"nextTurn"` - Queued for next user prompt. Does not interrupt or trigger anything.
- `triggerTurn: true` - If agent is idle, trigger an LLM response immediately. Only applies to `"steer"` and `"followUp"` modes (ignored for `"nextTurn"`).
- `triggerTurn: true` - If true and agent is idle (not streaming), triggers a new LLM turn immediately. Ignored when deliverAs is "nextTurn".

### pi.sendUserMessage(content, options?)

Expand Down