Documentation

Get your AI agent connected to AgentPulse in under 5 minutes.

1Create an Account

2Install the Plugin

Node.jsnpm package

Install via npm:

npm install @agentpulse/agentpulse

Then add to the top of your app:

const agentpulse = require('@agentpulse/agentpulse');agentpulse.init({ apiKey: 'ap_...', agentName: 'my-bot' });agentpulse.autoInstrument();// All OpenAI / Anthropic calls are now tracked automatically

Or install globally for the CLI:

sudo npm install -g @agentpulse/agentpulseagentpulse initagentpulse start -d

Pythonpipx / pip

SSH into your server where OpenClaw is running, then run this one-liner to install AgentPulse:

# Create a virtual environment and installpython3 -m venv ~/.agentpulse-venvsource ~/.agentpulse-venv/bin/activatepip install git+https://github.com/sru4ka/agentpulse.git#subdirectory=plugin

Note: On Ubuntu/Debian, Python requires a virtual environment for pip installs. The commands above handle this automatically.

Or use the quick install script:

curl -sSL https://raw.githubusercontent.com/sru4ka/agentpulse/main/plugin/install.sh | bash

3Configure

Run the interactive setup to configure your API key and agent:

agentpulse init

You'll be prompted for:

-API Key — from your Settings page
-Agent name — a name for this agent (e.g. "MoltBot")
-API endpoint — leave default unless self-hosting
-Log path — where OpenClaw writes logs (default: /tmp/openclaw/)

Or create the config file manually:

# ~/.openclaw/agentpulse.yamlapi_key: "ap_your_key_here"endpoint: "https://agentpulses.com/api/events"agent_name: "MyBot"framework: "openclaw"log_path: "/tmp/openclaw/"poll_interval: 5batch_interval: 30

4Start Monitoring

Start the AgentPulse daemon:

agentpulse start

Other useful commands:

agentpulse status # Check if runningagentpulse stop # Stop the daemon

5Run as a Service (Optional)

For production, run AgentPulse as a systemd service so it starts automatically:

# Create the service filesudo nano /etc/systemd/system/agentpulse.service

Paste this content:

[Unit]Description=AgentPulse Monitoring DaemonAfter=network.target [Service]Type=simpleUser=botExecStart=/root/.agentpulse-venv/bin/agentpulse startRestart=alwaysRestartSec=10 [Install]WantedBy=multi-user.target

Then enable and start it:

sudo systemctl enable agentpulsesudo systemctl start agentpulsesudo systemctl status agentpulse # Verify it's running

Supported Frameworks

OpenClaw

Full support. Gateway log parsing with model detection, error tracking, and cost estimation.

CrewAI

Coming soon. Plugin support in development.

LangGraph

Coming soon. Plugin support in development.

AutoGen

Coming soon. Plugin support in development.

API Reference

POST/api/events

Send events from your agent to AgentPulse.

{
  "api_key": "ap_your_key_here",
  "agent_name": "MyBot",
  "framework": "openclaw",
  "events": [
    {
      "timestamp": "2026-02-16T07:07:04.797Z",
      "provider": "minimax",
      "model": "MiniMax-M2.5",
      "input_tokens": 12500,
      "output_tokens": 850,
      "cost_usd": 0.2895,
      "latency_ms": 3200,
      "status": "success",
      "tools_used": ["web_search"],
      "error_message": null
    }
  ]
}

Troubleshooting

Node.js

AgentPulse is not a constructor

The SDK exports functions, not a class. Use agentpulse.init() not new AgentPulse().

Cannot find module '@agentpulse/agentpulse'

Run npm install @agentpulse/agentpulse in your project directory.

EACCES: permission denied (global install)

Use sudo npm install -g @agentpulse/agentpulse.

No events appearing on dashboard

Make sure init() is called before autoInstrument()
Verify your API key is correct
Events are batched — wait up to 10 seconds for them to appear
Run agentpulse test to confirm connectivity

agentpulse: command not found (after npm -g install)

Open a new terminal. Check that npm root -g is in your PATH.

Upgrade to latest version

Run npm update @agentpulse/agentpulse or sudo npm update -g @agentpulse/agentpulse for global.

Python

agentpulse: command not found

Run source ~/.bashrc or open a new terminal. Check pipx list and ensure ~/.local/bin is in your PATH.

Dashboard shows 0 events

Run agentpulse status to confirm it's running, then agentpulse test to verify connectivity.

API key invalid / 401 error

Re-run agentpulse init with a fresh key from your Settings page.

Upgrade to latest version

Run pipx upgrade agentpulse then agentpulse stop && agentpulse start -d.

Need Help?

Open an issue on GitHub or reach out to us.

Open an Issue