Docs / Developers

Developers

This section is for engineers integrating with CloudyBot — custom dashboards, internal tools, or automation that calls the same HTTP API as the hosted product. It explains behavior and boundaries without dumping internal vendor stacks. For step-by-step product usage, start at getting started instead.

Runtime shape

CloudyBot is a hosted Node.js API (default port 3000) plus an optional OpenClaw gateway for agent orchestration, tools, and channels. Your client authenticates with a Bearer session token, creates threads, then sends chat to POST /chat with a threadId. Billing, moderation, file workspace, browser sessions, and integration credentials are enforced server-side.

Threads — isolate conversation memory and pinned facts per thread_id.
Skills — tool families (browser_*, notion_*, email_*, …) gated per Specialist or chat context.
Specialists & cron — scheduled duties and workflow chains; see workflows and scheduled tasks.
Metering — AI credits, browser minutes, and other caps from plans.js; hard-stop at limit (limits FAQ).

Typical integration path

POST /api/auth/signup or POST /api/auth/login → session token.
POST /api/threads → threadId.
POST /chat with Authorization: Bearer …, message, and threadId.
Optional: GET /api/chat/history?threadId=… for UI replay; GET /usage/me for remaining credits.

Identity comes only from the session — do not trust userId in the request body. Full request/response tables: interactive API reference (canonical /api-docs).

Guides in this section

Architecture overview

Dashboard → API → assistant runs, cloud browser attachment, schedulers, and first-party connectors.

Memory model

Rolling summaries, pinned facts per thread, Specialist instructions — what the model sees each turn.

API reference

Pointer to the interactive OpenAPI-style spec — auth headers, threads, chat, webhooks.

Self-hosting and repo docs

The open-source tree under api/ is the product server. Operators clone the repo, copy api/.env.example, and run npm run dev. Deeper engineering references live in the repository (not duplicated here): docs/HANDOFF.md, docs/ARCHITECTURE.md, docs/API-REFERENCE.md. OpenClaw gateway development is optional and documented in the openclaw/ submodule.

Out of scope for public integrators

Admin routes — require X-Admin-Token; not for end-user API keys.
Lean Agent Provider — internal OpenClaw → API completion path; not a general third-party LLM proxy.
Undocumented internal URLs — may change without notice; use /api-docs paths only.

Related: Docs hub · FAQ · Security · Contact