# Send Bot Status API to your agent
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
## Fast path
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
## Suggested prompts
### New install

```text
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete.
```
### Upgrade existing

```text
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run.
```
## Machine-readable fields
```json
{
  "schemaVersion": "1.0",
  "item": {
    "slug": "bot-status-api",
    "name": "Bot Status API",
    "source": "tencent",
    "type": "skill",
    "category": "开发工具",
    "sourceUrl": "https://clawhub.ai/suspect80/bot-status-api",
    "canonicalUrl": "https://clawhub.ai/suspect80/bot-status-api",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadUrl": "/downloads/bot-status-api",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=bot-status-api",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "packageFormat": "ZIP package",
    "primaryDoc": "SKILL.md",
    "includedAssets": [
      "README.md",
      "SKILL.md",
      "collectors/core.js",
      "collectors/devservers.js",
      "collectors/docker.js",
      "collectors/email.js"
    ],
    "downloadMode": "redirect",
    "sourceHealth": {
      "source": "tencent",
      "slug": "bot-status-api",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-04-30T23:44:08.688Z",
      "expiresAt": "2026-05-07T23:44:08.688Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=bot-status-api",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=bot-status-api",
        "contentDisposition": "attachment; filename=\"bot-status-api-1.0.1.zip\"",
        "redirectLocation": null,
        "bodySnippet": null,
        "slug": "bot-status-api"
      },
      "scope": "item",
      "summary": "Item download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this item.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/bot-status-api"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    }
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/bot-status-api",
    "downloadUrl": "https://openagent3.xyz/downloads/bot-status-api",
    "agentUrl": "https://openagent3.xyz/skills/bot-status-api/agent",
    "manifestUrl": "https://openagent3.xyz/skills/bot-status-api/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/bot-status-api/agent.md"
  }
}
```
## Documentation

### Bot Status API

A configurable HTTP service that exposes your OpenClaw bot's operational status as JSON. Designed for dashboard integration, monitoring, and transparency.

### What It Provides

Bot Core: Online status, model, context usage, uptime, heartbeat timing
Services: Health checks for any HTTP endpoint, CLI tool, or file path
Email: Unread counts from any email provider (himalaya, gog, etc.)
Cron Jobs: Reads directly from OpenClaw's cron/jobs.json
Docker: Container health via Portainer API
Dev Servers: Auto-detects running dev servers by process grep
Skills: Lists installed and available OpenClaw skills
System: CPU, RAM, Disk metrics from /proc

### 1. Copy the service files

Copy server.js, collectors/, and package.json to your desired location.

### 2. Create config.json

Copy config.example.json to config.json and customize:

{
  "port": 3200,
  "name": "MyBot",
  "workspace": "/path/to/.openclaw/workspace",
  "openclawHome": "/path/to/.openclaw",
  "cache": { "ttlMs": 10000 },
  "model": "claude-sonnet-4-20250514",
  "skillDirs": ["/path/to/openclaw/skills"],
  "services": [
    { "name": "myservice", "type": "http", "url": "http://...", "healthPath": "/health" }
  ]
}

### Service Check Types

TypeDescriptionConfighttpFetch URL, check HTTP 200url, healthPath, method, headers, bodycommandRun shell command, check exit 0command, timeoutfile-existsCheck path existspath

### 3. Run

node server.js

### 4. Persist (systemd user service)

# ~/.config/systemd/user/bot-status.service
[Unit]
Description=Bot Status API
After=network.target

[Service]
Type=simple
WorkingDirectory=/path/to/bot-status
ExecStart=/usr/bin/node server.js
Restart=always
RestartSec=5
Environment=PORT=3200
Environment=HOME=/home/youruser
Environment=PATH=/usr/local/bin:/usr/bin:/bin

[Install]
WantedBy=default.target

systemctl --user daemon-reload
systemctl --user enable --now bot-status
loginctl enable-linger $USER  # survive logout

### 5. Context/Vitals from OpenClaw

The bot should periodically write vitals to heartbeat-state.json in its workspace:

{
  "vitals": {
    "contextPercent": 62,
    "contextUsed": 124000,
    "contextMax": 200000,
    "model": "claude-opus-4-5",
    "updatedAt": 1770304500000
  }
}

Add this to your HEARTBEAT.md so the bot updates it each heartbeat cycle.

### Endpoints

EndpointDescriptionGET /statusFull status JSON (cached)GET /healthSimple {"status":"ok"}

### Architecture

Zero dependencies — Node.js built-ins only (http, fs, child_process)
Non-blocking — All shell commands use async exec, never execSync
Background refresh — Cache refreshes on interval, requests always served from cache instantly (~10ms)
Config-driven — Everything in config.json, no hardcoded values
## Trust
- Source: tencent
- Verification: Indexed source record
- Publisher: suspect80
- Version: 1.0.1
## Source health
- Status: healthy
- Item download looks usable.
- Yavira can redirect you to the upstream package for this item.
- Health scope: item
- Reason: direct_download_ok
- Checked at: 2026-04-30T23:44:08.688Z
- Expires at: 2026-05-07T23:44:08.688Z
- Recommended action: Download for OpenClaw
## Links
- [Detail page](https://openagent3.xyz/skills/bot-status-api)
- [Send to Agent page](https://openagent3.xyz/skills/bot-status-api/agent)
- [JSON manifest](https://openagent3.xyz/skills/bot-status-api/agent.json)
- [Markdown brief](https://openagent3.xyz/skills/bot-status-api/agent.md)
- [Download page](https://openagent3.xyz/downloads/bot-status-api)