API Reference
Complete REST API documentation for Respira for WordPress
Base URL
All API endpoints are available at:
https://your-site.com/wp-json/respira/v1/ Authentication
All requests require an API key in the header:
X-Respira-API-Key: respira_your-api-key-here Endpoints
Get Site Context
Returns comprehensive information about the WordPress site.
GET /site/context List Pages
Get a list of all pages on the site.
GET /pages Read Page
Get the content of a specific page.
GET /pages/{id} Create Page Duplicate
Create a duplicate of a page for safe editing.
POST /pages/{id}/duplicate Update Page
Update page content, title, or other attributes.
POST /pages/{id} List Posts
Get a list of all posts.
GET /posts Read Post
Get the content of a specific post.
GET /posts/{id} Get Builder Info
Get information about detected page builders.
GET /builders Page Speed Analysis
Analyze Performance
Analyze page performance metrics including load time, image optimization, CSS/JS optimization, caching, and plugin performance impact.
GET /analyze/performance/{page_id} Get Core Web Vitals
Get Core Web Vitals scores (LCP, FID, CLS) for a page.
GET /analyze/core-web-vitals/{page_id} Analyze Images
Analyze image optimization opportunities including missing alt text, large files, and unoptimized formats.
GET /analyze/images/{page_id} SEO Analysis
Analyze SEO
Comprehensive SEO analysis including meta tags, heading structure, image alt text, internal linking, content quality, and schema markup.
GET /analyze/seo/{page_id} Check SEO Issues
Check for common SEO issues and get quick recommendations.
GET /analyze/seo-issues/{page_id} Analyze Readability
Analyze content readability including Flesch Reading Ease score, sentence length, and paragraph structure.
GET /analyze/readability/{page_id} AI Engine Optimization (AEO)
Analyze AEO
Analyze content for AI Engine Optimization (optimizing for AI search engines like Perplexity, ChatGPT). Checks structured data, content clarity, semantic HTML, entities, content depth, and FAQ opportunities.
GET /analyze/aeo/{page_id} Check Structured Data
Check schema markup and structured data (JSON-LD, microdata) for AI parsing.
GET /analyze/structured-data/{page_id} Plugin Management
EXPERIMENTAL⚠️ Plugin management is experimental and disabled by default. Enable it in Respira settings (WordPress Admin → Respira → Settings). Use with caution and always have backups.
List Plugins
List all installed plugins with their status, version, and update availability.
GET /plugins Install Plugin
Install a plugin from WordPress.org or a ZIP URL.
POST /plugins/install Body: {"slug_or_url": "plugin-slug", "source": "wordpress.org"}
Activate Plugin
Activate a plugin.
POST /plugins/{slug}/activate Deactivate Plugin
Deactivate a plugin.
POST /plugins/{slug}/deactivate Update Plugin
Update a plugin to the latest version.
POST /plugins/{slug}/update Delete Plugin
Permanently delete a plugin. The plugin must be deactivated first.
DELETE /plugins/{slug} Response Format
All responses are JSON. Success responses include data, error responses include a message:
{
"success": true,
"data": { ... }
}
{
"success": false,
"message": "Error message"
} 📚 Complete API Documentation
For comprehensive API documentation with detailed request/response examples, error handling, rate limiting, and security information, see our complete API reference.