Quick Start
Deploy your first AI agent in under 5 minutes and see the magic happen
Prerequisites: Python 3.8+ and pip installed on your system
The Magic You’re About to Experience
In the next 5 minutes, you’ll:
- Deploy a Python agent that responds intelligently to questions
- Call it from multiple languages like it’s a native function
- Stream responses in real-time across language boundaries
- Understand why this changes everything for AI development
Ready? Let’s make some magic happen ✨
Installation: Your Gateway to Multi-Language AI
Install RunAgent CLI (includes Python SDK):
Verify the installation:
What just happened? You now have both a powerful CLI for deploying agents AND a Python SDK for accessing them. Two tools, one install!
Create Your First Agent: From Zero to Intelligence
Let’s create a simple but intelligent agent that demonstrates RunAgent’s core superpower:
Initialize the Magic
What RunAgent just created for you:
Pro insight: This isn’t just boilerplate. Each file serves a specific purpose in making your Python agent accessible from any programming language.
Peek Under the Hood: See Your Agent's Brain
Your agent has two functions that will become universally accessible APIs:
The “Aha!” Moment: These Python functions accept message
and role
parameters. That’s exactly what you’ll pass from JavaScript, Rust, or any other language—RunAgent handles the translation!
The Configuration Bridge
Open runagent.config.json
to see how Python functions become universal APIs:
What this means:
- Your
mock_response
function becomes accessible via theminimal
tag - Your streaming function gets the
minimal_stream
tag (note the_stream
suffix!) - Any language can now call these functions by their tags
Activate Your Agent
Launch your agent into the RunAgent universe:
You’ll see magic happen:
Critical insight: That agent_id
is your agent’s universal address. Any programming language can now connect to your Python intelligence using this ID!
The Multi-Language Magic: Same Agent, Every Language
Now comes the mind-blowing part. Your Python agent is now accessible from any supported language as if it were written natively in that language.
Standard Responses: Get Complete Intelligence
The fastest way to prove the magic works:
Live output:
What just happened? You called your Python function from the command line with zero setup!
The fastest way to prove the magic works:
Live output:
What just happened? You called your Python function from the command line with zero setup!
The magic: This feels like calling a local Python function, but it’s actually making network calls to your deployed agent!
First, install in your JS project:
Then use your Python agent from JavaScript:
Mind-bending reality: JavaScript developers are now calling your Python AI agent as if it were native JavaScript code!
You can connect using the server URL instead of agent_id:
Why this matters: You can deploy to any server and connect from anywhere!
Streaming Intelligence: Real-Time AI Responses
Watch your Python agent stream responses in real-time to any language:
Experience real-time AI streaming in your terminal:
Live streaming output:
What’s happening: Your Python generator function is streaming across the network in real-time!
Experience real-time AI streaming in your terminal:
Live streaming output:
What’s happening: Your Python generator function is streaming across the network in real-time!
The beauty: This looks like a normal Python iterator, but chunks are streaming from your deployed agent in real-time!
Mind-blown moment: JavaScript developers are consuming real-time streams from your Python agent using native async iterators!
Performance revelation: Rust developers get zero-copy streaming from your Python agent with full type safety!
Level Up: Real AI Frameworks
Ready to move beyond mock responses? RunAgent works with any Python AI framework:
What you get: Multi-step reasoning agents with state management, accessible from any language!
What you get: Multi-step reasoning agents with state management, accessible from any language!
What you get: Coordinated AI agent teams working together, controllable from JavaScript, Rust, Go, or Python!
What you get: Total freedom to use any Python AI library while maintaining multi-language access!
Understanding the Universal Entrypoint System
This is the core concept that makes RunAgent revolutionary:
How Function Signatures Become Universal APIs
The Revolutionary Insight: Your Python function signature automatically defines the API contract for all programming languages. Change the Python function, and all language SDKs automatically adapt!
Streaming: The Real-Time Superpower
When you use Iterator[str]
in Python, RunAgent automatically:
- 🔄 Establishes WebSocket connections for real-time data flow
- 📡 Streams chunks immediately as your function yields them
- 🌐 Provides native iteration patterns in each target language
- ✅ Handles connection lifecycle and error recovery
What Just Happened? The Full Picture
In these 5 minutes, you’ve experienced something revolutionary:
🧠 Universal AI Access
Your Python AI agent is now callable from any programming language with native-feeling APIs
⚡ Real-Time Streaming
Streaming responses work seamlessly across language boundaries with zero setup
🔧 Zero Infrastructure
No REST APIs to build, no WebSocket handling, no deployment complexity
🚀 Production Ready
The same code and SDKs will work in production with automatic scaling
The Path Forward: Your RunAgent Journey
🏗️ Core Concepts Deep Dive
Understand the architecture that makes this magic possible
🌟 Multi-Language SDKs
Master the native patterns for each supported language
🎯 Real-World Examples
See production-ready agents built with popular frameworks
☁️ Production Deployment
Scale your agents to serve millions of requests
Common Questions from New Users
Why can't I connect to my agent?
Why can't I connect to my agent?
Most common fix: Make sure your agent is still running:
Then use the SDK in another terminal or Python script. The agent needs to stay active to receive requests!
My entrypoint tag isn't found
My entrypoint tag isn't found
Check your configuration: The tag in your SDK call must exactly match what’s in runagent.config.json
:
Remember: streaming tags must end with _stream
!
I get import errors with framework templates
I get import errors with framework templates
Install the dependencies: Framework templates come with requirements:
Port 8000 is already in use
Port 8000 is already in use
Use a different port:
Then connect using port=8080
in your SDK calls.
🎉 Congratulations! You’ve just experienced the future of AI development. Your Python agents can now be accessed from any programming language with the same ease as calling local functions. This is just the beginning—imagine what you’ll build next!
Ready to go deeper? Join our Discord community to see what other developers are creating with RunAgent!