API Overview - WhatsRB Cloud

Base URL: https://whatsrb.com/api/v1 — All requests require Authorization: Bearer YOUR_API_KEY

Resources

Agents

Create AI agents with system prompts, allowed actions, and structured fields. Run them on inbound messages or via API.

Agent Runs

Trigger agent runs and inspect results — structured output, tokens, latency, and conversation context.

Business Accounts

Connect WhatsApp Business accounts via Meta OAuth. Manage settings and human takeover duration.

Messages

Send text, images, documents, and template messages. Outbound messages auto-extend human takeover pauses.

Conversation Pauses

Pause AI agents per-conversation when a human takes over. Auto-expires, auto-extends on outbound.

Templates

Create, sync from Meta, and send pre-approved message templates with dynamic variables.

Webhooks

Sessions

Manage WhatsApp Web sessions via Baileys bridge. For dev/testing — use Business Accounts in production.

Usage

Monitor plan limits, message throughput, agent runs, and delivery metrics.

Authentication

Every request must include your API key as a Bearer token:

Authorization: Bearer wrb_live_xxxxxxxxxxxxx

Generate your key from the WhatsRB Dashboard under Settings → API Keys.

Keep your API key secret. Never expose it in client-side code or public repositories.

Response format

All responses return JSON. Successful responses wrap data in a data key:

{
  "data": {
    "id": "agt_abc123",
    "name": "Support Agent",
    "model": "gpt-4o-mini",
    "active": true,
    "allowed_actions": ["support.refund.process", "support.ticket.create"]
  }
}

List endpoints include a meta key with pagination info:

{
  "data": [...],
  "meta": {
    "total": 42,
    "plan_limit": 10
  }
}

Error format

Errors return a JSON object with a human-readable error key:

{
  "error": "Business account not found"
}

Status	Meaning
`400`	Bad request — invalid parameters
`401`	Unauthorized — missing or invalid API key
`403`	Forbidden — plan limit reached
`404`	Not found
`422`	Validation error
`429`	Rate limited
`5xx`	Server error

​Resources

Agents

Agent Runs

Business Accounts

Messages

Conversation Pauses

Templates

Webhooks

Sessions

Usage

​Authentication

​Response format

​Error format

Resources

Authentication

Response format

Error format