LemonX Developers · REST API

Build integrations on top of the LemonX WordPress AI stack.

The LemonX REST API gives developers a structured way to connect external tools, dashboards, AI workflows, automation platforms and internal systems with LemonX-powered WordPress websites.

Use the API to read site context, inspect content, create drafts, trigger AI workflows, manage translation queues, access SEO and AEO data, submit indexing requests, retrieve reports, monitor MCP activity and connect LemonX with your own systems.

Explore API Resources View Authentication See API Examples

WordPress-native · JSON-based · Permission-aware · Built for AI, SEO, translation and automation workflows

What is the LemonX REST API?

The LemonX REST API is a developer-facing interface for interacting with LemonX features through HTTP endpoints. It allows approved applications, dashboards, automation tools and AI systems to request data, trigger workflows and integrate with LemonX modules in a controlled way.

While MCP Tools are optimized for AI agents using the Model Context Protocol, the REST API is designed for developers building web apps, backend services, dashboards, scripts, middleware and automation workflows.

Connect LemonX with your own systems

Use REST endpoints to connect LemonX with CRMs, internal dashboards, reporting tools, agency portals, automation platforms and AI pipelines.

Build around WordPress data

Work with real WordPress content, metadata, taxonomies, media, users, languages and plugin states.

Trigger structured workflows

Create drafts, queue translations, generate SEO metadata, request indexing, retrieve reports and monitor actions.

Respect authentication and permissions

API requests should follow WordPress authentication, user capability checks, LemonX permissions and product entitlement rules.

REST API vs MCP

Two developer layers, built for different workflows.

REST API

Best for developer-built systems, backend integrations, dashboards, automation platforms, internal tools and custom applications.

Use REST API when you want to:

Build a custom admin dashboard.
Connect LemonX to your CRM.
Trigger workflows from another system.
Pull reports into a client portal.
Integrate with an automation platform.
Build your own SaaS layer on top of WordPress.
Run scheduled backend jobs.
Connect multiple sites to a central system.

MCP Tools

Best for AI agents, conversational workflows, Claude Desktop, Codex, Cursor and other MCP-compatible clients.

Use MCP Tools when you want to:

Let AI understand site context.
Ask AI to inspect pages.
Preview content changes.
Apply approved edits.
Generate content from a chat interface.
Let AI safely operate WordPress.
Create human-in-the-loop automation.

REST API is for applications and systems. MCP Tools are for AI agents. Together, they make LemonX both developer-friendly and AI-operable.

API resources

A modular API for the LemonX product ecosystem.

The LemonX REST API should follow the same modular structure as the LemonX Suite. Each product exposes its own resources, while shared resources handle authentication, licensing, site context, users, tasks, reports and logs.

Resource Group 1

Site API

Understand the connected WordPress environment.

The Site API provides basic information about the WordPress installation, active LemonX products, environment state, enabled modules and supported capabilities.

Example Endpoints

GET/wp-json/lemonx/v1/site

Returns basic site identity and environment details.

GET/wp-json/lemonx/v1/site/capabilities

Returns enabled LemonX modules and available feature groups.

GET/wp-json/lemonx/v1/site/health

Returns system health, plugin status, background task status and compatibility notes.

GET/wp-json/lemonx/v1/site/structure

Returns public post types, taxonomies, languages, templates and content structure.

Use Cases

Confirm a site connection.
Check which LemonX products are active.
Build a central agency dashboard.
Detect feature availability before showing UI.
Monitor site readiness before running automations.

Resource Group 2

Content API

Read, create and manage WordPress content through LemonX workflows.

The Content API gives developers access to posts, pages, drafts, content outlines, metadata, SEO fields, structured content and publishing states.

Example Endpoints

GET/wp-json/lemonx/v1/content

Lists posts, pages and supported custom post types.

GET/wp-json/lemonx/v1/content/{id}

Retrieves a specific content item.

POST/wp-json/lemonx/v1/content/drafts

Creates a new draft.

POST/wp-json/lemonx/v1/content/{id}/preview-update

Generates a preview update without applying changes.

POST/wp-json/lemonx/v1/content/{id}/apply-update

Applies an approved update.

GET/wp-json/lemonx/v1/content/{id}/outline

Returns headings, section structure and content hierarchy.

GET/wp-json/lemonx/v1/content/search

Searches content by query, type, status, author, taxonomy or language.

Use Cases

Create drafts from an external editorial system.
Pull WordPress content into a custom dashboard.
Generate content previews before applying changes.
Build content approval workflows.
Sync articles with an internal knowledge base.
Create agency content pipelines.

Resource Group 3

LemonX AEO API

Expose SEO and AI search optimization data.

The AEO API provides access to content optimization data, AI visibility checks, query analysis, citation tracking, schema suggestions, internal link recommendations, indexing workflows and reports.

Example Endpoints

GET/wp-json/lemonx/v1/aeo/overview

Returns a high-level summary of AEO status.

POST/wp-json/lemonx/v1/aeo/analyze

Analyzes a URL or content item for SEO and AEO readiness.

GET/wp-json/lemonx/v1/aeo/opportunities

Returns keyword, content and AI search opportunities.

GET/wp-json/lemonx/v1/aeo/citations

Returns AI citation and brand mention data when available.

POST/wp-json/lemonx/v1/aeo/schema/generate

Generates structured data suggestions.

POST/wp-json/lemonx/v1/aeo/internal-links/suggest

Returns internal link recommendations.

POST/wp-json/lemonx/v1/aeo/indexing/submit

Submits a URL to supported indexing channels.

GET/wp-json/lemonx/v1/aeo/reports

Lists available SEO and AEO reports.

Use Cases

Build a custom SEO dashboard.
Pull AEO opportunities into a project management tool.
Generate page-level optimization tasks.
Submit important URLs after publishing.
Create client-facing SEO reports.
Monitor AI search visibility.

Resource Group 4

LemonX Code API

Integrate AI page generation and builder workflows.

The Code API allows external systems to trigger page generation, retrieve templates, manage drafts, use knowledge base context, process OCR content and create structured sections.

Example Endpoints

GET/wp-json/lemonx/v1/code/templates

Lists available page and section templates.

POST/wp-json/lemonx/v1/code/pages/generate

Generates a page draft from a prompt or structured brief.

POST/wp-json/lemonx/v1/code/sections/generate

Generates a specific page section.

POST/wp-json/lemonx/v1/code/briefs

Creates a page or content brief.

GET/wp-json/lemonx/v1/code/knowledge-base

Lists available knowledge base sources.

POST/wp-json/lemonx/v1/code/knowledge-base/query

Queries private knowledge base context.

POST/wp-json/lemonx/v1/code/ocr/process

Processes an uploaded document or image through OCR when enabled.

POST/wp-json/lemonx/v1/code/migration/preview

Generates a migration preview for legacy content.

Use Cases

Create landing pages from an internal tool.
Generate pages from CRM product data.
Use private knowledge base content in automation workflows.
Convert old pages into structured layouts.
Build custom page generation pipelines.
Connect AI page generation to agency templates.

Resource Group 5

LemonX Verto API

Manage translation and multilingual SEO workflows.

The Verto API helps developers queue translations, check translation status, manage languages, retrieve translated content, update translated slugs, generate multilingual SEO fields and monitor translation progress.

Example Endpoints

GET/wp-json/lemonx/v1/verto/languages

Returns enabled languages and configuration.

GET/wp-json/lemonx/v1/verto/translations/{content_id}

Returns translation status for a content item.

POST/wp-json/lemonx/v1/verto/queue

Adds content to the translation queue.

POST/wp-json/lemonx/v1/verto/preview

Generates or retrieves a translation preview.

POST/wp-json/lemonx/v1/verto/apply

Applies an approved translation.

POST/wp-json/lemonx/v1/verto/seo/generate

Generates multilingual SEO title, meta description and social fields.

POST/wp-json/lemonx/v1/verto/slugs/update

Updates translated URL slugs where supported.

GET/wp-json/lemonx/v1/verto/reports

Returns translation progress and multilingual coverage reports.

Use Cases

Translate content from an external editorial system.
Build a multilingual publishing dashboard.
Track missing translations.
Queue product pages for translation.
Generate multilingual SEO metadata.
Monitor translation costs and queue progress.

Resource Group 6

LemonX MCP API

Monitor AI agent activity and MCP-related workflows.

The MCP API helps developers inspect MCP connection status, list available tools, review tool permissions, retrieve activity logs and monitor AI agent interactions.

Example Endpoints

GET/wp-json/lemonx/v1/mcp/status

Returns MCP server status and connection readiness.

GET/wp-json/lemonx/v1/mcp/tools

Lists available MCP tool groups.

GET/wp-json/lemonx/v1/mcp/tools/{tool_name}

Returns information about a specific tool.

GET/wp-json/lemonx/v1/mcp/logs

Returns MCP activity logs.

GET/wp-json/lemonx/v1/mcp/permissions

Returns MCP permission configuration.

POST/wp-json/lemonx/v1/mcp/previews/{preview_id}/apply

Applies an approved MCP preview.

POST/wp-json/lemonx/v1/mcp/previews/{preview_id}/discard

Discards a pending MCP preview.

Use Cases

Build an MCP admin dashboard.
Audit AI agent actions.
Check tool availability before connecting clients.
Review pending previews.
Monitor agency client sites.
Debug AI agent workflows.

Resource Group 7

LemonX Pro API

Connect licensing, entitlements, usage and cloud gateway data.

The Pro API provides access to license state, product entitlements, cloud gateway connectivity, feature availability, usage metrics and subscription-related states where permitted.

Example Endpoints

GET/wp-json/lemonx/v1/pro/license

Returns license status and activation details.

GET/wp-json/lemonx/v1/pro/entitlements

Returns enabled product entitlements and plan-level features.

GET/wp-json/lemonx/v1/pro/usage

Returns usage data such as AI calls, translation usage, indexing requests or cloud gateway consumption.

GET/wp-json/lemonx/v1/pro/cloud/status

Returns cloud gateway status.

POST/wp-json/lemonx/v1/pro/license/activate

Activates a license when allowed.

POST/wp-json/lemonx/v1/pro/license/deactivate

Deactivates a license from the current site.

Use Cases

Build account dashboards.
Monitor plan limits.
Check feature availability before using endpoints.
Manage multi-site agency licenses.
Debug cloud gateway connectivity.
Display usage to site administrators.

Resource Group 8

Reports API

Retrieve SEO, content, translation, MCP and usage reports.

The Reports API lets developers pull structured report data from LemonX modules and display it in dashboards, client portals, emails or business intelligence tools.

Example Endpoints

GET/wp-json/lemonx/v1/reports

Lists available report types.

GET/wp-json/lemonx/v1/reports/seo

Returns SEO and AEO summary data.

GET/wp-json/lemonx/v1/reports/content

Returns content production and update data.

GET/wp-json/lemonx/v1/reports/translation

Returns translation progress and language coverage.

GET/wp-json/lemonx/v1/reports/mcp

Returns MCP activity and AI agent usage.

GET/wp-json/lemonx/v1/reports/usage

Returns plan, API, AI and cloud usage summary.

POST/wp-json/lemonx/v1/reports/export

Generates an export-ready report draft.

Use Cases

Create client SEO dashboards.
Generate weekly agency reports.
Track AI usage across sites.
Monitor multilingual publishing progress.
Summarize MCP actions.
Export report data to external systems.

Resource Group 9

Tasks API

Track background jobs, queues and workflow execution.

Many LemonX workflows may run asynchronously, including translation queues, AI generation, indexing requests, OCR processing, report generation and migration previews. The Tasks API helps developers monitor those jobs.

Example Endpoints

GET/wp-json/lemonx/v1/tasks

Lists recent tasks.

GET/wp-json/lemonx/v1/tasks/{task_id}

Returns task status and result.

POST/wp-json/lemonx/v1/tasks/{task_id}/cancel

Cancels a pending task when supported.

GET/wp-json/lemonx/v1/tasks/queues

Returns queue health and active job counts.

GET/wp-json/lemonx/v1/tasks/history

Returns completed, failed and cancelled task history.

Use Cases

Monitor translation queue progress.
Track AI generation jobs.
Display status in a custom UI.
Debug failed workflows.
Build agency-level job monitoring.
Avoid duplicate processing.

Resource Group 10

Webhooks API

Manage event subscriptions and external callbacks.

The Webhooks API allows developers to register, list, update and remove webhook endpoints that receive events from LemonX workflows.

Example Endpoints

GET/wp-json/lemonx/v1/webhooks

Lists configured webhooks.

POST/wp-json/lemonx/v1/webhooks

Creates a webhook subscription.

GET/wp-json/lemonx/v1/webhooks/{id}

Returns webhook configuration.

PATCH/wp-json/lemonx/v1/webhooks/{id}

Updates a webhook subscription.

DELETE/wp-json/lemonx/v1/webhooks/{id}

Deletes a webhook subscription.

POST/wp-json/lemonx/v1/webhooks/{id}/test

Sends a test event to the webhook endpoint.

Use Cases

Notify external systems when content is published.
Trigger workflows after translation completion.
Send reports to a client portal.
Connect LemonX with Make, n8n or custom automation.
Trigger indexing after an external approval.
Log MCP actions in a security system.

Design principles

Designed for controlled WordPress automation.

Principle 1: WordPress-native

The API should respect WordPress content types, users, capabilities, taxonomies, media and plugin architecture instead of inventing a disconnected data model.

Principle 2: Permission-aware

Every endpoint should check whether the authenticated user or application has permission to perform the requested action.

Principle 3: Preview-first for risky changes

For content updates, SEO changes, translations and page edits, preview workflows should be preferred before applying changes.

Principle 4: Modular by product

AEO, Code, Verto, MCP and Pro resources should be organized clearly so developers can enable and use only what they need.

Principle 5: Structured JSON responses

Responses should be predictable, typed and friendly for both developers and AI systems.

Principle 6: Background task visibility

Long-running jobs should return task references that can be checked later.

Principle 7: Auditability

Important actions should be logged so site owners, agencies and developers can review what happened.

Authentication

Secure access starts with clear authentication.

LemonX REST API authentication should be designed around WordPress-native security and LemonX product permissions. Depending on the workflow, developers may use WordPress application passwords, authenticated admin sessions, API keys, OAuth-like flows, Cloud Gateway credentials or site-specific tokens.

For sensitive workflows, authentication should be combined with capability checks, nonce validation, product entitlement verification and activity logging.

Common Authentication Methods

WordPress Application Passwords

Useful for server-to-server access and trusted integrations.

WordPress Logged-in User Session

Useful for admin dashboard interactions and browser-based tools.

API Key

Useful for selected integration workflows where a dedicated token is required.

Cloud Gateway Token

Useful for LemonX Pro and cloud-connected workflows.

MCP Authorization Context

Useful when API actions relate to MCP previews, AI agent sessions or tool execution.

Read Authentication Guide

Example request

A simple REST API request.

Example

curl -X GET "https://example.com/wp-json/lemonx/v1/site" 
  -H "Authorization: Bearer YOUR_API_TOKEN" 
  -H "Accept: application/json"

Example Response

JSON

{
  "site": {
    "name": "Example WordPress Site",
    "url": "https://example.com",
    "wordpress_version": "6.x",
    "lemonx_version": "1.x"
  },
  "products": {
    "aeo": true,
    "code": true,
    "verto": true,
    "mcp": true,
    "pro": true,
    "theme": false
  },
  "capabilities": [
    "content.read",
    "content.preview",
    "aeo.analyze",
    "verto.queue",
    "mcp.logs.read"
  ]
}

Endpoint names and response structures should be treated as developer-facing examples. Final implementation details should match the active LemonX plugin version and documentation.

Response format

Predictable responses make integrations easier to build.

Success Response

Error Response

Task Response

Error handling

Common API error codes.

Error Code	Meaning	Recommended Action
invalid_request	Required fields are missing or invalid	Check request payload
unauthenticated	No valid authentication was provided	Authenticate the request
permission_denied	User or token lacks required capability	Check role and permissions
product_inactive	Required LemonX product is not active	Enable the product
entitlement_required	Feature requires Pro or higher plan	Check license and plan
resource_not_found	Requested item does not exist	Verify ID or URL
validation_failed	Payload failed validation	Review field errors
task_failed	Background job failed	Check task details
rate_limited	Too many requests	Retry later or reduce frequency
cloud_unavailable	Cloud Gateway is unavailable	Check cloud status
provider_unavailable	AI or translation provider failed	Retry or use backup provider

Rate limits

Protect your site from unnecessary load.

API workflows should be designed with sensible rate limits, especially for AI generation, translation, indexing, OCR, report generation and cloud-connected actions. Developers should avoid repeatedly calling expensive endpoints when cached or task-based responses are available.

Recommended Practices

Cache site capability results.
Use pagination for list endpoints.
Use task polling intervals for long-running jobs.
Avoid duplicate indexing submissions.
Batch translation queue requests where supported.
Use webhooks instead of constant polling when possible.
Respect plan-based usage and quota limits.

Pagination

Work with large WordPress sites safely.

Example Request

curl "https://example.com/wp-json/lemonx/v1/content?type=post&page=1&per_page=20"

Example Response

{
  "success": true,
  "data": [{ "id": 101, "title": "Example Post", "status": "publish" }],
  "pagination": { "page": 1, "per_page": 20, "total": 328, "total_pages": 17 }
}

Best Practice: Use pagination for content, media, logs, reports, tasks and large translation queues. Avoid requesting entire site datasets in a single call.

Safe write pattern

Use preview before apply for important changes.

For content updates, SEO changes, translation updates and page layout modifications, developers should use a preview-apply pattern. This prevents accidental overwrites and keeps humans in control.

Step 1: Create preview

POST /wp-json/lemonx/v1/content/123/preview-update

Step 2: Review preview

The API returns proposed changes, before/after differences and a preview reference.

Step 3: Apply approved update

POST /wp-json/lemonx/v1/content/123/apply-update

Step 4: Log action

The applied update is stored in activity logs for review.

Why it matters: AI-generated changes can be useful, but production websites need review, traceability and clear rollback paths. Preview-apply workflows reduce risk while keeping automation powerful.

Events

Use webhooks when your system needs to react.

Instead of constantly polling the REST API, developers can use webhooks to receive events when important LemonX actions occur.

Example Events

content.createdcontent.updatedcontent.preview_createdaeo.analysis_completedaeo.indexing_submittedverto.translation_queuedverto.translation_completedmcp.action_completedmcp.preview_createdreport.generatedlicense.status_changedtask.failed

Explore Webhooks

Example workflows

What can you build with the REST API?

Workflow 1

Agency dashboard

Goal: Monitor multiple LemonX-powered client sites from one dashboard.

API Flow:

GET /site
GET /site/health
GET /pro/license
GET /aeo/overview
GET /verto/reports
GET /mcp/logs
GET /reports/seo

Result: Your agency team can see site health, SEO status, translation progress, license state and AI activity in one place.

Workflow 2

External content pipeline

Goal: Create WordPress drafts from an external editorial system.

API Flow:

POST /content/drafts
POST /aeo/schema/generate
POST /aeo/internal-links/suggest
POST /content/{id}/preview-update
POST /verto/queue

Result: Content created outside WordPress enters LemonX as structured drafts, gets SEO-ready and can be queued for translation.

Workflow 3

Multilingual product publishing

Goal: Publish or prepare translated versions of WooCommerce product pages.

API Flow:

GET /verto/languages
POST /verto/queue
GET /tasks/{task_id}
POST /verto/seo/generate
POST /verto/apply
POST /aeo/indexing/submit

Result: Product pages are translated, multilingual SEO fields are generated and URLs can be prepared for indexing.

Workflow 4

AI page generation app

Goal: Build an external UI where users generate WordPress landing pages.

API Flow:

GET /code/templates
POST /code/pages/generate
POST /code/sections/generate
POST /content/drafts
POST /content/{id}/preview-update

Result: Your external app can generate page drafts inside WordPress using LemonX Code workflows.

Workflow 5

Security and activity monitor

Goal: Track AI agent actions and sensitive site operations.

API Flow:

GET /mcp/logs
GET /tasks/history
GET /reports/mcp
GET /site/health
GET /pro/usage

Result: Site owners and agencies can review AI activity, detect failed tasks and monitor high-impact workflows.

Best practices

Build reliable integrations with LemonX REST API.

Check capabilities first

Before calling product-specific endpoints, check site capabilities and active products.

Use the least privileged token

Do not use administrator-level credentials for workflows that only need read access or draft creation.

Prefer preview workflows

Use preview endpoints before applying content, translation, SEO or layout changes.

Design around tasks

AI generation, translation, OCR and reports may take time. Use task IDs and status endpoints instead of assuming instant completion.

Use webhooks for external systems

If your system needs to react to events, use webhooks instead of frequent polling.

Respect usage limits

AI, translation, indexing and cloud-connected actions may be subject to plan limits and quotas.

Log important actions

Store request IDs, task IDs and action references in your external system.

Handle partial failures

Large workflows may complete some steps and fail others. Design your integration to retry safely.

Validate content before publishing

AI-generated content should go through editorial, SEO and brand review before publishing live.

Keep endpoints versioned

Use versioned endpoints and update integrations when LemonX releases API changes.

Use cases

Who should use the LemonX REST API?

Use Case 1: Agencies

Build dashboards for multiple client sites, generate reports, monitor activity and automate repeatable content workflows.

Use Case 2: SaaS Platforms

Connect LemonX-powered WordPress sites to your platform and trigger content, SEO, translation or reporting workflows.

Use Case 3: Internal Marketing Teams

Connect WordPress content operations with internal planning tools, editorial calendars and reporting dashboards.

Use Case 4: Developers

Build custom plugins, admin screens, automation scripts, migration tools and external applications.

Use Case 5: AI Workflow Builders

Combine REST API workflows with MCP, webhooks and AI provider pipelines.

Use Case 6: Ecommerce Teams

Automate product content, multilingual product pages, SEO fields, schema and indexing workflows.

Comparison

How is LemonX REST API different from the default WordPress REST API?

WordPress REST API

Provides general access to WordPress posts, pages, media, users, taxonomies and settings.
Great for standard WordPress data operations.

LemonX REST API

Provides access to LemonX-specific workflows such as AEO analysis, AI content generation, translation queues, MCP activity, indexing, reports, product entitlements, cloud gateway status and AI-powered previews.
Great for AI growth automation.

The LemonX REST API does not replace the WordPress REST API. It extends the developer surface with product-specific AI, SEO, translation, MCP and growth workflows.

Build your next WordPress AI integration with LemonX.

Use the REST API to connect LemonX with your own systems, dashboards, automations and client workflows.

View API Examples Read Authentication Guide

REST API FAQ

What is the LemonX REST API used for?

It is used to connect LemonX-powered WordPress websites with external tools, dashboards, automations, AI workflows and internal systems.

Is the LemonX REST API the same as the WordPress REST API?

No. The WordPress REST API exposes general WordPress resources. The LemonX REST API exposes LemonX-specific workflows such as AEO analysis, AI generation, translation, MCP logs, indexing, reports and licensing.

Can I create WordPress drafts through the API?

Yes, content endpoints can support draft creation and preview workflows where enabled.

Can I trigger translation through the API?

Yes, Verto endpoints can support translation queues, status checks, previews and multilingual SEO generation.

Can I access AEO data through the API?

Yes, AEO endpoints can expose analysis results, opportunities, schema suggestions, indexing workflows and reports.

Can I monitor MCP activity?

Yes, MCP endpoints can provide status, tool lists, permissions, previews and activity logs.

Does the REST API require authentication?

Yes. API access should require valid authentication and permission checks.

Can I use the API for client dashboards?

Yes. Agencies can use the REST API to build dashboards that show site health, license state, SEO progress, translation progress, MCP activity and reports.

Are API endpoints available in every LemonX plan?

Some endpoints may require specific products or Pro entitlements. Developers should check capabilities and entitlements before calling product-specific endpoints.

Can I build automations with the REST API?

Yes. The REST API can be combined with webhooks, tasks, MCP tools and external automation platforms to build structured WordPress workflows.

Turn LemonX into your WordPress AI development platform.

From content workflows to SEO automation, from translation queues to MCP logs, from licensing to reports — the LemonX REST API gives developers a structured way to build on top of the LemonX ecosystem.

Explore API Examples Continue to Hooks & Filters Read Authentication Guide