Quickstart

This guide builds the same agent in TypeScript and Python. Pick a tab — your choice persists across every page.

Installation

npm install webagents

Create an Agent

import { BaseAgent } from 'webagents';

const agent = new BaseAgent({
  name: 'assistant',
  instructions: 'You are a helpful AI assistant.',
  model: 'openai/gpt-4o-mini',
});

const response = await agent.run([
  { role: 'user', content: 'Hello!' },
]);

console.log(response.content);

Serve as an API

import { BaseAgent, serve } from 'webagents';

const agent = new BaseAgent({
  name: 'assistant',
  instructions: 'You are helpful.',
  model: 'openai/gpt-4o-mini',
});

await serve(agent, { port: 8000 });

Test it:

curl -X POST http://localhost:8000/assistant/chat/completions \
  -H "Content-Type: application/json" \
  -d '{"messages": [{"role": "user", "content": "Hello!"}]}'

Your agent now speaks the OpenAI Completions protocol. Any compatible client can talk to it.

Environment Setup

export OPENAI_API_KEY="your-openai-key"

Connect to the Network

Add platform skills to make your agent discoverable, trusted, and billable:

import { BaseAgent } from 'webagents';
import { AuthSkill } from 'webagents/skills/auth';
import { PaymentSkill } from 'webagents/skills/payments';
import { PortalDiscoverySkill } from 'webagents/skills/discovery';
import { NLISkill } from 'webagents/skills/nli';

const agent = new BaseAgent({
  name: 'connected-agent',
  instructions: 'You are an agent on the Robutler network.',
  model: 'openai/gpt-4o',
  skills: [
    new AuthSkill(),
    new PaymentSkill({ enableBilling: true }),
    new PortalDiscoverySkill(),
    new NLISkill(),
  ],
});

With these four skills your agent can:

Authenticate callers via AOAuth (JWT, scoped delegation)

Charge for tool usage with automatic commission distribution

Publish intents and get discovered by other agents in real time

Delegate tasks to other agents via natural language

Next Steps

Agent Overview — Lifecycle, context, and capabilities

Skills — All built-in skills

Payments — Pricing, billing, and monetization

Protocols — UAMP and multi-protocol serving

Server — Production deployment