Agent skill

inbox-zero-api

Use the Inbox Zero API CLI to inspect the live API schema, list and manage automation rules, and read inbox analytics through the public API. Use this when a task involves Inbox Zero rules, stats, or API-driven automation and can be solved through the CLI instead of browser interaction.

View SKILL.md on GitHub Repository
Stars 10,372
Forks 1,251

Install this agent skill to your Project

npx add-skill https://github.com/elie222/inbox-zero/tree/main/clawhub/inbox-zero-api

Metadata

Additional technical details for this skill

openclaw 
{
    "install": [
        {
            "id": "node",
            "bins": [
                "inbox-zero-api"
            ],
            "kind": "node",
            "label": "Install Inbox Zero API CLI (npm)",
            "package": "@inbox-zero/api"
        }
    ],
    "requires": {
        "env": [
            "INBOX_ZERO_API_KEY"
        ],
        "bins": [
            "inbox-zero-api"
        ]
    },
    "skillKey": "inboxZeroApi",
    "primaryEnv": "INBOX_ZERO_API_KEY"
}

SKILL.md

Inbox Zero API CLI

Use this skill when the task is to inspect or change Inbox Zero state through the public API.

Workflow

  1. Prefer --json so the output is stable and machine-readable.
  2. For authenticated commands (rules, stats, etc.), keep credentials in INBOX_ZERO_API_KEY or OpenClaw skill config. Avoid passing API keys as CLI flags unless there is no alternative.
  3. Before creating or replacing a rule body, fetch the live schema with inbox-zero-api openapi --json (no API key required).
  4. For create and update flows, write JSON into a workspace file or pipe it on stdin.
  5. Treat rules update as a full replacement. Read the current rule first if you only intend to change part of it.

Quick Start

bash
inbox-zero-api rules list --json
inbox-zero-api stats by-period --period week --json
inbox-zero-api openapi --json

If the CLI is not installed yet, install it with the OpenClaw installer or run npm install -g @inbox-zero/api.

Cursor

Set INBOX_ZERO_API_KEY when using authenticated commands (rules, stats, etc.); openapi --json works without a key. Use shell profile, Cursor env, or a local env file—never commit keys. Install: npm install -g @inbox-zero/api or npx @inbox-zero/api.

OpenClaw Config

Set the API key in ~/.openclaw/openclaw.json under skills.entries.inboxZeroApi.apiKey, or export INBOX_ZERO_API_KEY in the host environment.

Use INBOX_ZERO_BASE_URL or inbox-zero-api config set base-url <url> only for self-hosted or nonstandard deployments.

Reference

For exact command patterns and a safe mutation flow, read references/cli-reference.md.

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

elie222/inbox-zero

qa-new-flow

Create a new browser QA flow file from the template

10,372 1,251
Explore
elie222/inbox-zero

llm

Guidelines for implementing LLM (Language Model) functionality in the application

10,372 1,251
Explore
elie222/inbox-zero

fullstack-workflow

Complete fullstack workflow combining GET API routes, server actions, SWR data fetching, and form handling. Use when building features that need both data fetching and mutations from API to UI.

10,372 1,251
Explore
elie222/inbox-zero

write-tests

Write focused unit tests for backend and utility logic

10,372 1,251
Explore
elie222/inbox-zero

e2e

Run and debug E2E flow tests. Use when triggering E2E tests, checking test status, debugging failures with Axiom logs, or setting up local E2E testing.

10,372 1,251
Explore
elie222/inbox-zero

prisma

How to use Prisma

10,372 1,251
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results