How It Works
Quick Start
Which Style Should I Use?
Pick a preset based on where the output is consumed.How It Works
| Preset | Description | Best For |
|---|---|---|
silent | No output, returns value only (default) | SDK / programmatic use |
editor | Step 1: 📄 Creating file → ✓ Done | CLI default, beginners |
status | ▸ AI → thinking + inline tool calls | Simple CLI output |
trace | Status with [HH:MM:SS] timestamps | Progress monitoring |
debug | Trace + metrics, no boxes | Developer debugging |
verbose | Task + Tools + Response panels | Interactive sessions |
stream | Real-time token streaming | Chat interfaces |
json | JSONL events on stdout | Scripting / piping |
Configuration Options
OutputConfig SDK Reference
Full parameter reference for OutputConfig
| Option | Type | Default | Description |
|---|---|---|---|
verbose | bool | False | Show Rich panels for tasks and responses |
markdown | bool | False | Render markdown formatting |
stream | bool | False | Stream tokens in real time |
metrics | bool | False | Display token usage and cost after each response |
reasoning_steps | bool | False | Show internal reasoning steps |
actions_trace | bool | False | Show tool calls and lifecycle events on stderr |
json_output | bool | False | Emit JSONL events for piping |
simple_output | bool | False | Print response without Rich panels |
status_trace | bool | False | Clean inline status updates |
editor_output | bool | False | Numbered steps with emoji icons (CLI default) |
show_parameters | bool | False | Show LLM parameters (debug preset) |
style | Any | None | Custom output styling object |
output_file | str | None | File path to automatically save the agent response |
template | str | None | Format template for the response |
tool_output_limit | int | 16000 | Maximum characters for tool output |
String Preset Aliases
| Alias | Maps To |
|---|---|
plain, minimal | silent |
normal | verbose |
text, actions | status |
Common Patterns
Silent (SDK Default)
Status (CLI / Interactive)
Save Response to File
Best Practices
Use silent mode for production APIs
Use silent mode for production APIs
Silent mode (the default) has zero output overhead. Use it when the agent’s return value is consumed by code rather than displayed to users.
Use editor mode for beginner-facing CLIs
Use editor mode for beginner-facing CLIs
output="editor" shows human-friendly numbered steps with emoji icons. It is the default when running praisonai "prompt" from the command line.Use stream mode for chat interfaces
Use stream mode for chat interfaces
Set
output="stream" when building conversational UIs — tokens appear in real time for a responsive feel.Use output_file to persist long-form responses
Use output_file to persist long-form responses
Set
output=OutputConfig(output_file="result.md") to automatically save the agent’s response. Useful for reports, summaries, and generated documents.Related
Async Agents
Run agents asynchronously for better performance
Callbacks
Hook into agent lifecycle events

