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 Cloud 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 | usage.getSummary | App-scoped usage and limits |
| Responses | responses.get, responses.getEvents, responses.cancel | Terminal status and output; use background: true for async work |
| Webhooks | Webhooks guide | Delivery and signature failures |
| Errors | TypeScript BeeOSAPIError; Python APIError; Go *APIError | HTTP status, stable code, request ID |
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.
Method signatures and errors are in the API reference.
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.