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/page context to RankPilotAI, receives an optimised snippet and writes it directly into Rank Math fields — without leaving the editor.

Writes into Rank Math only: Focus Keyword, SEO Title, Meta Description and (optionally) the post Slug.

2. Key Features

2.1 Token Cost per Model

3. Requirements

• WordPress 5.8 or higher
• Rank Math SEO (Free or Pro)
• PHP 7.4+
• An active RankPilotAI account + Site Key

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. Go 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 token (rp_xxxxxxxxxxxxxxxxx).

5.2 Save the Key in WordPress

1. Go to Settings → AI Snippet SEO Helper → Site Key Management.
2. Paste your token and click Save Site Key. Usage, limit and remaining tokens will appear.

5.3 Configure SEO Settings (optional)

• Model Choice — GPT-4 Turbo / 4.1 / 4o (plan-aware).
• Custom Prompt — global text appended to each request.
• Auto-Slug — when enabled, the AI slug replaces the current one; WordPress adds a 301 redirect automatically.

6. Day-to-Day Usage

6.1 Single Post / Page

1. Open a post/page.
2. In the AI Snippet SEO Helper metabox, click Generate with AI Snippet SEO Helper.
3. Focus Keyword, SEO Title, Meta Description (and optionally Slug) fill in. Review and update.

6.2 Bulk Generation

1. Go to any public post-type list (e.g. Posts).
2. Select items → Bulk Actions → Generate with AI Snippet SEO Helper → Apply.
3. A live progress box shows processed / success / failed. You can Cancel mid-run.

6.3 How the Score is Calculated

• Keyword present in Title, Description and Slug (3 checks)
• Title length 30–60 chars
• Description length 120–160 chars
• Slug length ≤ 75 chars

Final score = min(100, checks passed × 17). Stored in _aish_score (private 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. Troubleshooting

Permissions: You must be able to edit_post for single runs and edit_posts for bulk; settings require manage_options.

10. Frequently Asked Questions

11. Developer Hooks & Filters

/* Example: add a brand suffix to titles only */
add_filter('aish/snippet_response', function($res){
    if (!empty($res['title'])) {
        $res['title'] .= ' | Acme®';
    }
    return $res;
}, 10, 1);

/* Example: inject extra context into outgoing payload */
add_filter('aish/snippet_payload', function($payload, $token){
    $payload['brand_terms'] = ['Acme','UltraLight™'];
    return $payload;
}, 10, 2);