Platform API Reference - Charm Docs

This reference is auto-generated from the Charm Cloud Runner OpenAPI specification. Use the sidebar to browse individual endpoints grouped by domain.

Endpoint Groups

Group	Description
Execute	Start an agent run with SSE streaming output.
Agents	CRUD operations for agent registrations.
Versions	Upgrade, rollback, and list agent versions.
Runs	Inspect, complete, cancel, and track run progress.
Threads	Query run history within a conversation thread.
Studio	Dashboard analytics: stats, installs, errors, usage logs.
Billing	Wallet, subscriptions, transactions, and Stripe webhooks.
Daemons	Manage long-running daemon agent processes.

Authentication

API routes use different auth models depending on the caller:

Supabase bearer token — user-facing requests from Charm Store / Studio.
Runner secret — internal callbacks from the Cloud Runner.
Cron secret — scheduled maintenance jobs.
Stripe webhook secret — payment event verification.

Base URL

{api_base_url}

OpenAPI Spec

The raw specification powering this reference is available at openapi.json. You can import it into Postman, Insomnia, or any OpenAPI-compatible tool.