MarlinVix for WordPress is now in early access. Create a workspace
MarlinVix

Developer documentation

Connect WordPress to the MarlinVix API.

Follow the activation flow, sign every plugin request and use stable error codes when handling API responses.

GET /api/public/v1/system/health

1. Connect your site

  1. Create a workspace and register the canonical website domain.
  2. Issue a license key and copy it when shown.
  3. Install the MarlinVix WordPress plugin and enter the key.
  4. Activation binds that license to the registered domain.

2. Sign each request

The signature is an HMAC-SHA256 of timestamp.nonce.domain.sha256(body) keyed by the license secret. Requests outside the five-minute window or reusing a nonce are rejected.

x-mvx-license:   MVX_xxxxxxxxxxxxxxxx
x-mvx-domain:    example.com
x-mvx-timestamp: 1730000000
x-mvx-nonce:     8f3c1d...
x-mvx-signature: <hex hmac-sha256>

3. Versioned endpoints

MethodPathPurpose
POST/api/public/v1/plugin/licenses/activateConnect a WordPress site with a license key.
POST/api/public/v1/plugin/free/registerConnect a WordPress site on the free plan.
POST/api/public/v1/plugin/licenses/validateRevalidate a connection and read authoritative limits.
POST/api/public/v1/plugin/licenses/deactivateDisconnect a WordPress site.
POST/api/public/v1/plugin/managed/chatAsk a visitor question through Managed AI (signed).
POST/api/public/v1/plugin/heartbeatReport plugin health.
POST/api/public/v1/plugin/usageReport display metrics.
POST/api/public/v1/licenses/verifyCheck license state.
GET/api/public/v1/system/healthRead system health.

4. Handle stable errors

Branch on the error code and retain the request identifier when contacting support.

{
  "error": {
    "code": "LICENSE_INVALID",
    "message": "That license key was not recognised.",
    "request_id": "req_..."
  }
}