Getting Started
Before deploying your agent, you’ll need a Cycls API key.- Go to the Cycls Console and sign in or create an account.
- Navigate to the API Keys section.
- Create a new API key and copy it securely.
Deploying to Production
To deploy your agent, set your API key and callapp.deploy():
Environment Variables & Secrets
Create a.env file in your project root and include it with copy=[".env"]:
.env file—environment variables are available via os.getenv() inside your function without needing any additional packages.
What Happens During Deployment?
When you runapp.deploy(), Cycls performs the following steps:
- Build: Creates a Docker image containing your code, dependencies (
pip), and system packages (apt). - Push: Uploads the image to the private Cycls Container Registry.
- Provision: Sets up the serverless infrastructure to host your agent.
- Deploy: Launches your agent and assigns it a permanent URL (e.g.,
https://app.cycls.ai).
Deployment Output
Updating Your Agent
To update your agent, simply make changes to your code and run the script again. Cycls will build a new version and seamlessly update the deployment with zero downtime.Local vs Cloud
| Feature | app.local() | app.deploy() |
|---|---|---|
| URL | http://localhost:8080 | https://<name>.cycls.ai |
| Hot Reload | Yes (default) | No |
| SSL | No | Yes (automatic) |
| Scaling | Single container | Auto-scaling |
| Auth | Optional | Optional |