runagent.config.json
file is the heart of your RunAgent project. It defines how your agent is configured, deployed, and executed.
Basic Structure
Configuration Fields
Core Fields
Unique identifier for your agent. Used in deployment and SDK initialization.
- Must be lowercase
- Can contain letters, numbers, hyphens, and underscores
- Maximum 50 characters
Human-readable description of what your agent does. Displayed in dashboards and listings.
The AI framework your agent uses. Supported values:
langgraph
crewai
agno
letta
custom
Template Information
Name of the template used to create this project. Helps with updates and migration.
Source information for the template:
Agent Architecture
Defines how RunAgent interacts with your code:
Environment Variables
Environment variables for your agent. Supports two formats:
- Dynamic substitution:
"${VAR_NAME}"
- Reads from environment - Fixed values:
"fixed_value"
- Uses the literal value
Never hardcode sensitive values like API keys. Always use dynamic substitution.
Entrypoint Types
Generic Entrypoint
Standard request/response pattern:Streaming Entrypoint
For real-time response streaming:Advanced Configuration
Multiple Entrypoints
You can define multiple entrypoints for different use cases:Environment Variable Patterns
Validation
RunAgent validates your configuration on:runagent init
- When creating a projectrunagent serve
- Before starting local serverrunagent deploy
- Before deployment
Missing required fields
Missing required fields
Ensure all required fields (
agent_name
, framework
, version
, agent_architecture
) are present.Invalid entrypoint module
Invalid entrypoint module
Check that the module path is correct and the file exists.
Unsupported framework
Unsupported framework
Use one of the supported frameworks or
"custom"
for others.Best Practices
Use Semantic Versioning
Follow SemVer for your version numbers to track changes properly
Document Entrypoints
Add comments in your code explaining what each entrypoint does
Environment Variables
Never hardcode secrets. Always use environment variable substitution
Validate Locally
Test your configuration with
runagent serve
before deploying