Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.swarms.world/llms.txt

Use this file to discover all available pages before exploring further.

The Swarms framework provides powerful real-time streaming capabilities for agents, allowing you to see responses being generated token by token as they’re produced by the language model. This creates a more engaging and interactive experience, especially useful for long-form content generation, debugging, or when you want to provide immediate feedback to users.

​
Installation

Install the swarms package using pip: 
pip install -U swarms

​
Basic Setup

  1. First, set up your environment variables:
WORKSPACE_DIR="agent_workspace"
OPENAI_API_KEY=""

​
Step by Step

  • Install and put your keys in .env
  • Turn on streaming in Agent() with streaming_on=True
  • Optional: If you want to pretty print it, you can do print_on=True; if not, it will print normally

​
Code

from swarms import Agent

# Enable real-time streaming
agent = Agent(
    agent_name="StoryAgent",
    model_name="gpt-5.4",
    streaming_on=True,  # 🔥 This enables real streaming!
    max_loops=1,
    print_on=True,  # By default, it's False for raw streaming!
)

# This will now stream in real-time with a beautiful UI!
response = agent.run("Tell me a detailed story about humanity colonizing the stars")
print(response)

​
Connect With Us

If you’d like technical support, join our Discord below and stay updated on our Twitter for new updates!
PlatformLinkDescription
📚 Documentationdocs.swarms.worldOfficial documentation and guides
📝 BlogMediumLatest updates and technical articles
💬 DiscordJoin DiscordLive chat and community support
🐦 Twitter@kyegomezLatest news and announcements
👥 LinkedInThe Swarm CorporationProfessional network and updates
📺 YouTubeSwarms ChannelTutorials and demos
🎫 EventsSign up hereJoin our community events