This reference is currently available in English. The Cloud console remains in your selected language.
BEEOS CLOUD / DEVELOPER REFERENCE
Operations, usage, and errors
Handle lifecycle state, usage limits, webhook delivery, and request failures
Instance creation and lifecycle mutations can be asynchronous. The canonical Go Server SDK returns instance data plus an operation on create, stop, and delete. Read instances.getStatus until the environment reports readiness or a terminal failure. Use a stable idempotency key for retries; use a fresh key for a distinct intent.
| Area | Available surface | What to watch |
|---|---|---|
| Usage | Candidate usage.getSummary, getHistory, getLimits | App-scoped usage and limits |
| Tasks | tasks.get, listMessages, cancel, continueTask | Terminal state and message history |
| Webhooks | taskWebhooks.listDeliveries, redeliver, verifySignature | Delivery and signature failures |
| Errors | TypeScript BeeOSAPIError; Go ResponseError | HTTP status, stable code, request ID |
| Runtime | methods.getCapabilities | Method availability per instance |
Use If-Match resource versions for versioned writes. A mismatch should trigger a fresh read and deliberate merge, not an automatic overwrite. Preserve X-Request-ID when reporting failures. For webhook handling, verify the exact raw body before parsing JSON and make handlers idempotent.
Console billing and organization limits are separate from the SDK's usage read methods. Pricing and live quota values should come from the current account and environment; these docs do not state a fixed rate card.