Python API

Every name exported by the cycls package, with its purpose and the page that documents it.

Reference for import cycls. Names are listed by area.

Decorators

Name	Signature	Documented in
cycls.function	(name=None, image=None, *, cpu=None, memory=None, timeout=None, concurrency=None, volumes=None, schedule=None, python_version=None)	Functions
cycls.app	(name=None, image=None, *, volumes=None, auth=None, memory="1Gi")	Apps
cycls.agent	(name=None, image=None, *, web=None, volumes=None, memory="1Gi")	Agents
cycls.local_entrypoint	(fn)	Functions

Builders

Name	Purpose	Documented in
cycls.Image	container build configuration	Images
cycls.Volume	named persistent storage	Volumes
cycls.Cron	schedule for a deployed function	Cron
cycls.Web	interface, auth, branding, analytics	Interface
cycls.LLM	model, prompt, tools, budgets	Models
cycls.MCP	a remote MCP server	Connectors and MCP
cycls.Sandbox	bubblewrap command execution	Apps

Authentication

Name	Purpose	Documented in
cycls.Clerk	Clerk provider, hosted defaults	Authentication
cycls.JWT	any OIDC provider with a JWKS URL	Authentication
cycls.GCP	Firebase and GCP Identity Platform	Authentication
cycls.AppleIAP	StoreKit 2 entitlement verification	Plans and quotas
cycls.User	the authenticated user model	Authentication

Connectors

Name	Purpose	Documented in
cycls.OAuth2	authorization code grant with PKCE	Connectors
cycls.Key	a key the user pastes	Connectors
cycls.Endpoint	a private URL that is itself the credential	Connectors
cycls.env	a deployment secret resolved at use time	Connectors

Storage

Name	Purpose	Documented in
cycls.DB	per-user JSON key-value store on a volume	Volumes
cycls.Workspace	a resolved storage scope	Context

Analytics and notifications

Name	Purpose	Documented in
cycls.PostHog	PostHog analytics provider	Interface
cycls.GTM	Google Tag Manager provider	Interface
cycls.OneSignal	web push provider	Interface
cycls.log	one structured log record	Observability

Remote execution

Name	Purpose	Documented in
cycls.remote(name)	callable for a deployed endpoint, with .map()	Functions
cycls.RemoteError	raised when a remote call fails	Functions

Events

Name	Purpose	Documented in
cycls.events	dict factories for loop events	Custom loops
cycls.to_ui	identity function kept for older code	Agents

Module configuration

import cycls

cycls.api_key = "..."      # same as CYCLS_API_KEY
cycls.base_url = "..."     # same as CYCLS_BASE_URL

Object methods

Function, App and Agent

Method	Available on	Meaning
.run(*args, **kwargs)	Function	execute in local Docker
.remote(*args, **kwargs)	Function	execute current code in the cloud
.map(items, workers=16)	Function	fan out, ordered results
.build()	Function	build the image only
.watch(*args, **kwargs)	Function	run with file watching
.local(port=8080, watch=True)	App, Agent	serve in Docker
.deploy()	all	publish
.server	App, Agent	route registrations replayed in the container
.auth	App, Agent	FastAPI dependency returning the User
.workspace	App, Agent	FastAPI dependency returning the Workspace
.prod	App, Agent	True when deployed

Next

Agent HTTP API

Every endpoint a deployed agent serves.