Skip to main content

Documentation Index

Fetch the complete documentation index at: https://openclaw-simplex.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The plugin registers these gateway RPC methods for invite/address automation and programmatic onboarding flows.
For day-to-day operator workflows, prefer the plugin CLI commands in Example Commands. Use these gateway methods when another system needs the same invite/address flow programmatically, including QR data URLs.

​
Prerequisites and behavior

  • The target SimpleX account must be enabled and configured under channels.openclaw-simplex.
  • The simplex-chat WebSocket runtime must be reachable for that account.
  • If accountId is omitted or blank, the plugin uses the channel’s default account.
  • If the channel is not running, these methods ask OpenClaw to start openclaw-simplex for the target account and retry the SimpleX command.

​
simplex.invite.create

Create a one-time connect link or an address link. Request params: 
{
  "mode": "connect",
  "accountId": "default"
}
mode supports:
  • connect -> runs /c
  • address -> runs /ad
Response highlights:
  • link: the generated SimpleX link
  • qrDataUrl: PNG QR image as a data: URL for the same link
Example response shape: 
{
  "accountId": "default",
  "command": "/c",
  "mode": "connect",
  "link": "simplex://...",
  "qrDataUrl": "data:image/png;base64,..."
}

​
simplex.invite.list

List current invite/address links and pending contact hints. Internally this combines /show_address and /contacts. Request params: 
{
  "accountId": "default"
}
Response highlights:
  • addressLink: current address link if available
  • links: extracted invite/address links seen in the responses
  • pendingHints: pending contact hints from /contacts
  • addressQrDataUrl: PNG QR image as a data: URL for addressLink
Example response shape: 
{
  "accountId": "default",
  "addressLink": "simplex://...",
  "links": ["simplex://..."],
  "pendingHints": [],
  "addressQrDataUrl": "data:image/png;base64,..."
}

​
simplex.invite.revoke

Revoke the active address link by running /delete_address. Request params: 
{
  "accountId": "default"
}
Example response shape: 
{
  "accountId": "default",
  "response": {
    "corrId": "..."
  }
}

​
Errors

CodeMeaning
INVALID_REQUESTThe request params are invalid. For example, simplex.invite.create received an unsupported mode.
UNAVAILABLEThe account is disabled/unconfigured, the channel runtime is unavailable, or the underlying SimpleX command failed. The response message includes the failure reason.
The plugin also exposes these agent/tool-surface operations. They are not gateway RPC methods, but they cover the same invite and group administration flows from inside an agent run.
  • simplex_invite_create
  • simplex_invite_list
  • simplex_invite_revoke
  • simplex_group_add_participant
  • simplex_group_remove_participant
  • simplex_group_leave
These destructive tools require approval before execution:
  • simplex_invite_revoke
  • simplex_group_remove_participant
  • simplex_group_leave