This reference is currently available in English. The Cloud console remains in your selected language.
BEEOS CLOUD / DEVELOPER REFERENCE
Build a custom agent
Connect your own agent loop to BeeOS chat, cancellation, and management methods
The host process owns its model loop and inbound transport. BeeOS supplies the identity, message, file, canvas, and A2A ports through the Harness SDK.
Receive runtime identity
Configure the Agent Gateway URL, Message Service URL, instance ID, agent ID, and runtime token from your deployment. Keep the token inside the agent process.
Register handlers
Handle `onChatMessage`, `onChatCancel`, and the `onRuntimeMethod` methods your framework supports.
Wire the host transport
Pass inbound envelopes to `consumeEnvelope`. Route C14 method requests to `dispatchRuntimeMethod`.
Reply and shut down
Reply with the inbound message ID, stop work on cancellation, and call `close` on process shutdown.
The smallest chat handler is runtime.messages.reply(event.conversationId, event.messageId, text). A richer agent can use files, canvas, A2A, and messaging ports while working. When a Server SDK caller invokes skills/list or session/set_model, the runtime method handler executes the framework-specific operation. Callers should first check runtime capabilities.
Important: The Harness SDK does not expose the Cloud Server REST surface and does not accept a
bsk_key. Use the Server SDK in a trusted product backend for instance and user management.