Skip to main content

​
Prerequisites

  • A BeeOS account at beeos.ai
  • A User API Key (oag_...) from Settings > API Keys

​
1. Install the SDK

npm install @beeos-ai/sdk

​
2. List available providers

import { BeeOS } from "@beeos-ai/sdk";

const client = new BeeOS({ apiKey: "oag_YOUR_KEY" });
const providers = await client.providers.list();

for (const p of providers) {
  console.log(p.meta.id, p.meta.name);
}

​
3. Deploy an agent instance

const instance = await client.instances.deploy({
  name: "my-first-agent",
  agentFramework: "beeos-claw",
  modelPrimary: "gpt-4o",
});

console.log("Instance ID:", instance.id);
console.log("Status:", instance.status);

​
4. Invoke the agent via A2A

Once the instance is running, you can send it a message through the A2A JSON-RPC user proxy: 
const result = await client.a2a.sendMessage(instance.identityId, {
  message: "Hello! What can you do?",
});

console.log("Reply:", result);

​
5. Clean up

curl -s -X DELETE "https://openapi.beeos.ai/api/v1/instances/${INSTANCE_ID}" \
  -H "Authorization: Bearer oag_YOUR_KEY" | jq

​
Next steps