Save Agent Output - PraisonAI

Save agent responses to files automatically — pass a path, use OutputConfig, or let the agent call write_file.

from praisonaiagents import Agent

agent = Agent(
    instructions="You are a helpful writer",
    output="poem.txt",
)
agent.start("Write a poem about nature")

The user asks for content; the agent writes the response to the configured output file.

Quick Start

Simple Usage

Pass a file path string to output:

from praisonaiagents import Agent

agent = Agent(
    instructions="You are a helpful writer",
    output="poem.txt",
)
agent.start("Write a poem about nature")
# Output saved to poem.txt

With Configuration

Use OutputConfig for template formatting:

from praisonaiagents import Agent, OutputConfig

agent = Agent(
    instructions="You are a helpful writer",
    output=OutputConfig(
        output_file="poem.txt",
        template="# {{title}}\n\n{{content}}",
    ),
)
agent.start("Write a poem about nature")

How It Works

The user sends a request; the agent generates a response and the framework writes it to the configured output file.

Methods Comparison

Method	Best For	Auto-Save	Agent Control
String Path	Simplest usage	Yes	Framework
OutputConfig	Template formatting	Yes	Framework
write_file Tool	Dynamic file operations	No	Agent decides
Task.output_file	Task-based workflows	Yes	Framework
Workflow output_file	YAML workflows	Yes	Framework
Manual	Full control	No	Developer

Method 1: String Path (Simplest)

One line - just pass a file path string to output.

Basic Usage

from praisonaiagents import Agent

agent = Agent(
    instructions="You are a helpful writer",
    output="output/response.txt"
)

agent.start("Write a poem about nature")
# ✅ Output saved to output/response.txt

With Directory

from praisonaiagents import Agent

agent = Agent(
    instructions="You are a researcher",
    output="reports/summary.md"
)

agent.start("Summarize AI trends")
# ✅ Creates reports/ directory if needed
# ✅ Output saved to reports/summary.md

The agent automatically creates parent directories if they don’t exist.

Method 2: OutputConfig (With Template)

Use OutputConfig when you need to save output AND apply template formatting.

Recommended: For response templates without file saving, use TemplateConfig.response instead. See Templates for details.

With Template

from praisonaiagents import Agent, OutputConfig

agent = Agent(
    instructions="You are a blog writer",
    output=OutputConfig(
        output_file="blog_post.md",
        template="""# {{title}}

{{content}}

---
*Generated by AI*
"""
    )
)

agent.start("Write about Python programming")

The template instructs the agent to format its response accordingly. Both OutputConfig.template and TemplateConfig.response work - use TemplateConfig.response when you don’t need file saving.

Combined with Other Settings

agent = Agent(
    instructions="You are a researcher",
    output=OutputConfig(
        verbose=True,              # Show rich terminal output
        output_file="research.md", # Also save to file
        template="## Summary\n\n{{content}}"
    )
)

Method 3: write_file Tool

Recommended when the agent needs to decide what to save and where.

Basic Usage

from praisonaiagents import Agent
from praisonaiagents.tools import write_file

agent = Agent(
    name="ReportWriter",
    role="Technical Writer",
    goal="Create and save technical documentation",
    tools=[write_file]
)

# Agent will use write_file tool to save the report
agent.start("Write a technical report about Python and save it to report.md")

With Multiple File Tools

from praisonaiagents import Agent
from praisonaiagents.tools import read_file, write_file, list_files

agent = Agent(
    name="FileManager",
    instructions="Manage files: read, write, and organize",
    tools=[read_file, write_file, list_files]
)

agent.start("Read config.json, update the version to 2.0, and save as config_new.json")

The agent autonomously decides when to call write_file based on the task.

Method 4: Task output_file

Recommended for task-based workflows where you want automatic file saving.

Basic Usage

from praisonaiagents import Agent, Task, AgentTeam

# Create agent
writer = Agent(
    name="ContentWriter",
    role="Writer",
    goal="Create engaging content"
)

# Task with output_file
task = Task(
    description="Write a blog post about machine learning",
    expected_output="A well-structured blog post in markdown",
    agent=writer,
    output_file="blog_post.md",
    create_directory=True  # Creates parent directories if needed
)

# Run
agents = AgentTeam(agents=[writer], tasks=[task])
result = agents.start()
# File automatically saved to blog_post.md

Multiple Tasks with Different Outputs

from praisonaiagents import Agent, Task, AgentTeam

researcher = Agent(name="Researcher", role="Research Analyst")
writer = Agent(name="Writer", role="Content Writer")

research_task = Task(
    description="Research AI trends for 2024",
    agent=researcher,
    output_file="research/ai_trends.txt"
)

writing_task = Task(
    description="Write a summary based on the research",
    agent=writer,
    output_file="output/summary.md",
    create_directory=True
)

agents = AgentTeam(
    agents=[researcher, writer],
    tasks=[research_task, writing_task],
    process="sequential"
)
agents.start()
# Creates: research/ai_trends.txt and output/summary.md

Method 5: Workflow output_file

Recommended for YAML-based workflows with variable substitution.

agents.yaml Example

metadata:
  name: content-generator
  version: "1.0"

variables:
  output_dir: "generated"
  topic: "artificial intelligence"

agents:
  writer:
    role: Content Writer
    goal: Create engaging content about {{topic}}
    llm: gpt-4o-mini

steps:
  - agent: writer
    action: "Write a comprehensive article about {{topic}}"
    expected_output: "A well-structured article in markdown format"
    output_file: "{{output_dir}}/article.md"

Run the Workflow

praisonai agents.yaml

from praisonaiagents import AgentFlow

workflow = Workflow.from_yaml("agents.yaml")
workflow.run()
# Output saved to: generated/article.md

Method 6: Manual Capture

Use when you need full control over the saving process.

Basic Manual Save

from praisonaiagents import Agent
import json

agent = Agent(name="DataProcessor")
response = agent.start("Generate a list of 5 programming languages with descriptions")

# Save as text
with open("languages.txt", "w") as f:
    f.write(response)

# Or save as JSON (if response is structured)
with open("languages.json", "w") as f:
    json.dump({"content": response}, f, indent=2)

With Error Handling

from praisonaiagents import Agent
from pathlib import Path

agent = Agent(name="Writer")
response = agent.start("Write a short story")

output_path = Path("stories/short_story.txt")
output_path.parent.mkdir(parents=True, exist_ok=True)

try:
    output_path.write_text(response)
    print(f"✅ Saved to {output_path}")
except IOError as e:
    print(f"❌ Failed to save: {e}")

Best Practices

Choose the Right Method

Scenario	Recommended Method
Simplest usage	String path (`output="file.txt"`)
Template formatting	`OutputConfig`
Agent decides what to save	`write_file` tool
Auto-save task results	`Task.output_file`
YAML workflows	Workflow `output_file`
Custom save logic	Manual capture

Use create_directory

Always set create_directory=True when using Task.output_file to avoid errors:

Task(
    output_file="deep/nested/path/file.txt",
    create_directory=True  # Creates all parent directories
)

Use Variables in Workflows

Use variables for flexible output paths:

variables:
  output_dir: "reports"
  date: "2024-01"

steps:
  - output_file: "{{output_dir}}/{{date}}/report.md"

Handle Large Outputs

For large outputs, consider streaming to file:

agent = Agent(name="Writer")

with open("large_output.txt", "w") as f:
    for chunk in agent.stream("Generate a long document"):
        f.write(chunk)
        f.flush()

Complete Example

Install

pip install praisonaiagents
export OPENAI_API_KEY="${OPENAI_API_KEY:?Set OPENAI_API_KEY in your shell}"

Create Agent with File Tools

from praisonaiagents import Agent
from praisonaiagents.tools import write_file, read_file

agent = Agent(
    name="DocumentProcessor",
    role="Document Specialist",
    goal="Process and save documents efficiently",
    tools=[write_file, read_file]
)

Run and Save

# Agent will automatically save to the specified file
result = agent.start("""
    Write a project README with:
    - Project title: My AI Project
    - Description
    - Installation steps
    - Usage examples
    
    Save it to README.md
""")

print("✅ Document saved!")

File Tools

Complete file operations reference

Workflows

YAML workflow configuration

​Quick Start

​How It Works

​Methods Comparison

​Method 1: String Path (Simplest)

​Basic Usage

​With Directory

​Method 2: OutputConfig (With Template)

​With Template

​Combined with Other Settings

​Method 3: write_file Tool

​Basic Usage

​With Multiple File Tools

​Method 4: Task output_file

​Basic Usage

​Multiple Tasks with Different Outputs

​Method 5: Workflow output_file

​agents.yaml Example

​Run the Workflow

​Method 6: Manual Capture

​Basic Manual Save

​With Error Handling

​Best Practices

​Complete Example

​Related

File Tools

Workflows

Quick Start

How It Works

Methods Comparison

Method 1: String Path (Simplest)

Basic Usage

With Directory

Method 2: OutputConfig (With Template)

With Template

Combined with Other Settings

Method 3: write_file Tool

Basic Usage

With Multiple File Tools

Method 4: Task output_file

Basic Usage

Multiple Tasks with Different Outputs

Method 5: Workflow output_file

agents.yaml Example

Run the Workflow

Method 6: Manual Capture

Basic Manual Save

With Error Handling

Best Practices

Complete Example

Related