DocsHarness SDK

BEEOS CLOUD / DEVELOPER REFERENCE

Agent ports and errors

Use runtime-side messaging, files, canvas, A2A, and agent identity

These ports are implemented in the inspected TypeScript Harness SDK. Each request uses the runtime token plus X-BeeOS-Instance-ID and X-BeeOS-Agent-ID.

PortCallsDestination
agentget, updateExposure, syncAgent Gateway /api/v1/agents
messagessend, reply, list, consumeEnvelopeMessage Service /api/v2/conversations
fileslist, presign, confirm, resolveAgent Gateway /api/v1/agent/files
canvastokenAgent Gateway /api/v1/canvas/token
a2adiscover, call, getTaskAgent Gateway /api/v1/a2a
messagingtokenAgent Gateway /api/v1/messaging/token

Message lifecycle

Message Service sends an envelope through the host adapter and Harness SDK to agent logic, which replies with the inbound message IDOpen the diagram at full size

BeeOSAgentError has status and code. The SDK raises unsupported_runtime_method for a name outside the 28 listed method names and runtime_method_unhandled if no handler is registered. An HTTP failure is surfaced as agent_backend_unavailable unless the response supplies its own code. Handle cancellation by stopping the work identified by targetMessageId; a cancel event is not itself a terminal answer.

For presigned files, obtain a URL with files.presign, transfer the bytes using the returned storage instructions, then files.confirm. files.resolve obtains a download descriptor. The SDK port does not transfer bytes on its own.