Skip to main content

​
Clawd API Surface

clawd.rigbox.dev is built on top of the same Rigbox API base (https://api.rigbox.dev/api), plus Clawd-specific behavior for OpenClaw bots, AI credits, and billing UX. Use this guide as an API map when building your own Clawd-like experience.

​
API Groups

GroupWhat it doesShould you use it in your own app?
Core Rigbox APIsWorkspaces, apps, routing, logs, metrics, snapshots, tools, tasksYes, these are the foundation
AI Config APIsAI provider settings, managed/BYOK state, credits, usageYes, if you integrate AI providers
Clawd billing/plan APIsCheckout, plan switching, portal sessionsOptional; use your own billing stack if preferred

​
Core Rigbox APIs Used by Clawd

EndpointUsed for
GET /workspaces, GET /workspaces/{id}Workspace list/detail state
POST /workspaces/{id}/start, POST /workspaces/{id}/stopLifecycle controls
PUT /workspaces/{id}/resourcesResize workspace RAM/vCPU/disk
GET /workspaces/{id}/metricsRuntime usage cards/graphs
GET /workspaces/{id}/logsWorkspace-level logs
POST /quick-deployOne-shot template provisioning
POST /workspaces/{id}/reconcile-appsEnsure template apps exist
GET /apps, POST /apps, PATCH /apps/{id}, DELETE /apps/{id}App CRUD + rename
PUT /apps/{id}/visibilityPublic/private/privileged app access
GET /apps/{id}/healthLive URL health validation
GET /apps/{id}/log-sources, GET /apps/{id}/logs, GET /apps/{id}/logs/streamApp logs UI
GET /users/me/limitsPlan limits and usage
GET /capacityCapacity checks before create flows
GET /api-keys, POST /api-keys, DELETE /api-keys/{id}Programmatic access management
GET /workspaces/{id}/tools, POST /workspaces/{id}/tools/{tool}/installTool management
GET /workspaces/{id}/tasksTask sync and display
GET /setup-scripts, POST /setup-scriptsWorkspace initialization automation
GET /service-specs, POST /service-specsService configuration templates

​
AI Config APIs Used by Clawd

These are the APIs that manage AI provider configuration:
EndpointResponsibility
GET /workspaces/{id}/ai-configRead current AI provider configuration
PUT /workspaces/{id}/ai-configUpdate AI config (mode/provider/api_key/model)
POST /workspaces/{id}/envGeneric env writes (legacy/fallback path)
GET /users/me/creditsManaged AI credit balance
GET /users/me/ai-usageAI usage history
GET /users/me/ai-defaultsDefault AI provider settings
PUT /users/me/ai-defaultsUpdate default AI settings
Prefer PUT /workspaces/{id}/ai-config for AI provider changes. It is normalized and safer than raw env mutation.

​
Billing and Subscription APIs Used by Clawd UI

EndpointPurpose
POST /auth/create-checkout-sessionStart Stripe checkout
GET /auth/subscription-statusResolve active plan status
POST /auth/create-portal-sessionOpen Stripe customer portal
POST /auth/switch-planPlan switch workflow
If you build your own dashboard, you can replace these with your own billing backend while still using the same core Rigbox APIs.

​
Minimal Clawd-Like Integration Flow

  1. Call POST /quick-deploy with template_id: "openclaw".
  2. Start and poll workspace state until running.
  3. Call POST /workspaces/{id}/reconcile-apps.
  4. Use GET /apps/{id}/health before surfacing app URLs as live.
  5. Save AI settings through PUT /workspaces/{id}/ai-config.
  6. Show plan/credit context with GET /users/me/limits and GET /users/me/credits.
For runtime internals (AI proxy and credit enforcement pipeline), continue to /clawd-runtime-services.