AI Snippet SEO Helper Documentation

1. Overview

AI Snippet SEO Helper is a lightweight WordPress add-on that bridges RankPilotAI and Rank Math. It sends the current post or page context to RankPilotAI’s API, receives an optimised snippet and writes it directly into Rank Math’s fields—speeding up your on-page workflow without leaving the editor.

2. Key Features

3. Requirements

• WordPress 5.8 or higher
• Rank Math SEO (free or Pro)
• PHP 7.4+
• A Site Key issued by an active RankPilotAI account (Free plan included)

4. Installation & Activation

1. Upload the ZIP via Plugins → Add New → Upload or extract to /wp-content/plugins/.
2. Activate AI Snippet SEO Helper.
3. Navigate to Settings → AI Snippet SEO Helper and paste your Site Key.

5. Getting Started

5.1 Generate a Site Key

1. Log in to your RankPilotAI dashboard.
2. Open Account → Site Key Management.
3. Enter your site’s main domain (e.g. example.com) and click Generate Key.
4. Copy the resulting token (rp_xxxxxxxxxxxxxxxxx).

5.2 Save the Site Key in WordPress

1. Go to Settings → AI Snippet SEO Helper → Site Key Management.
2. Paste your token and click Save Site Key.
3. The page shows current usage, plan limit and remaining tokens.

5.3 Configure SEO Settings (optional)

• Model Choice – GPT-4 Turbo / 4.1 / 4o (availability depends on plan).
• Custom Prompt – global text appended to each request.
• Auto Slug – if enabled, suggested slug replaces the current one automatically.

6. Day-to-Day Usage

6.1 Single Post / Page

1. Open any post or page in the WordPress editor.
2. In the Rank Math meta-box, click Generate Snippet with AI.
3. Wait a few seconds; Focus Keyword, Title, Description (and optionally Slug) fill in.
4. Review the result and update the post.

6.2 Bulk Generation

1. Go to any post-type list (e.g. Posts).
2. Select items → Bulk Actions → Generate with AI Snippet SEO Helper → Apply.
3. Progress and any failures show via admin notices.

6.3 Understanding the Score

After generation the helper stores a private meta field _aish_score (0–100). Higher scores mean better keyword alignment and length conformity. You can surface this field in custom reports or with get_post_meta().

7. Admin Panel Reference

7.1 Site Key Management Tab

7.2 SEO Snippet Settings Tab

8. Plans, Tokens & Limits

Need extra tokens? Purchase a Token Pack (100 – 5,000 lifetime tokens) from your RankPilotAI dashboard and assign it to AI Snippet SEO Helper.

9. Frequently Asked Questions

Q: The button doesn’t appear in Rank Math.
A: Ensure Rank Math is active and you are editing a public post-type. Clear caches and reload.

Q: API response: “No tokens left”.
A: You’ve exhausted your monthly quota. Upgrade your plan or buy a Token Pack.

Q: Can I use Yoast SEO instead of Rank Math?
A: Not at this time. The helper integrates directly with Rank Math hooks.

Q: Does bulk generation overwrite existing data?
A: Yes. Existing Rank Math fields will be replaced. Use with caution.

10. Hooks & Filters

// Trigger a custom action after a successful single generation
do_action( 'aish_after_generate', int $post_id );

// Change the default payload before it is sent to RankPilotAI
add_filter( 'aish_payload', function ( $payload, $post_id ) {
    // …modify $payload here…
    return $payload;
}, 10, 2 );

11. Changelog

• v 1.2.2 – 25 May 2025 – Added Auto Slug setting, improved bulk stability, GPT-4o support.
• v 1.2.1 – 12 Apr 2025 – Token overview added to settings page.
• v 1.2.0 – 19 Mar 2025 – Initial public release.