Skip to main content
Dify can reach BeeOS in two ways:

MCP provider

Add a custom MCP server using the BeeOS Streamable HTTP endpoint:
Store the Authorization: Bearer <oag_key> header in Dify’s encrypted credential configuration. After tool discovery, attach the BeeOS tool only to the agents that are allowed to operate that device. Use MCP for conversational applications. Keep the Dify system prompt explicit about actions that require confirmation and how to report partial failure.

OpenAPI custom tool

For deterministic workflows, import the BeeOS OpenAPI document from the API Reference or define only the operations the workflow needs. Configure bearer authentication with an oag_... user API key. Prefer a small operation set:
  1. List or resolve the target agent.
  2. Create a durable task.
  3. Read task status.
  4. Cancel the task.
This is safer than exposing the entire platform contract to one model. Use stable operation IDs and re-import the schema when the BeeOS OpenAPI version changes.
Do not embed a BeeOS key in a Dify DSL export. Bind credentials after importing the application into each environment.

Error handling

Map BeeOS terminal status to explicit Dify branches. Bound every poll loop, surface timeout and cancellation separately in the user experience, and never automatically replay a phone action merely because its response was lost. See MCP Gateway, Authentication, and Task Lifecycle.