Python SDK

BeeOS publishes two related Python packages:

Package	Purpose
`beeos`	Recommended official entry point and stable facade.
`beeos-sdk`	Complete OpenAPI-generated client, imported as `beeos_sdk`.

Both target the Platform OpenAPI at https://openapi.beeos.ai. They do not wrap the separate A2A or MCP protocols.

Building a LangChain or LangGraph application? langchain-beeos builds on the public beeos package and exposes its instance, Agent, computer, and mobile operations as typed tools. See LangChain and LangGraph.

Install

python -m pip install beeos

The beeos package installs a compatible beeos-sdk dependency. Install beeos-sdk directly only when generated-client imports are preferred. Application deployments should pin the resolved versions in their lockfile. The documentation intentionally does not hard-code patch versions, so package releases do not require a documentation-only update.

Configure

Set the API key once in your environment:

export BEEOS_API_KEY="oag_..."

BeeOS() reads BEEOS_API_KEY automatically and uses the production API by default. Set BEEOS_API_URL only when targeting another environment.

Create an async task

from beeos import BeeOS

client = BeeOS()
agent = client.agents.list().data[0]
task = client.tasks.create(
    agent_id=agent.id,
    message="Create a promotional video for BeeOS",
)

print(task.data.task_id)

Authentication uses the same user JWT or oag_ User API Key as the other OpenAPI SDKs. The client does not require a with block; context-manager usage is available when an explicit lifetime is useful.

Explicit configuration

from beeos import BeeOS

client = BeeOS(
    api_key="oag_...",
    base_url="https://openapi.beeos.ai",
)

Use beeos.sdk for the complete generated API and model surface. The equivalent direct imports are available from beeos_sdk:

import beeos_sdk

configuration = beeos_sdk.Configuration(
    host="https://openapi.beeos.ai",
    access_token="oag_...",
)

with beeos_sdk.ApiClient(configuration) as api_client:
    agents = beeos_sdk.AgentsApi(api_client).list_agents()

Generation and compatibility

beeos-sdk is generated from the same beeos-platform-v1.yaml contract as the TypeScript and Go clients. Generated classes and method names may change when the OpenAPI contract has a breaking release; use the official beeos facade for the stable top-level imports.

Getting Started

Guides

Architecture

A2A Protocol

MCP

Integrations

SDKs

Reference

Install

Configure

Create an async task

Explicit configuration

Generation and compatibility

​Install

​Configure

​Create an async task

​Explicit configuration

​Generation and compatibility

Install

Configure

Create an async task

Explicit configuration

Generation and compatibility