AI Snippet SEO Pro Documentation – RankPilotAI

AI Snippet SEO Pro Documentation

Create flawlessly optimised, Google-friendly SEO snippets for any post, page or taxonomy with a single click.

1. What is it? 2. Key Features 3. Requirements 4. Installation 5. Licensing & Tokens 6. Quick-Start 7. Meta Box 8. SEO Settings 9. Dashboard 10. Troubleshooting 11. FAQ 12. Changelog 13. Developer Hooks 14. Support

1. What is AI Snippet SEO Pro?

AI Snippet SEO Pro communicates with the RankPilotAI API via a site-specific key and a usage-based token pool. Each generation request consumes tokens according to the GPT model you select:

GPT Model	Tokens per Snippet
🟢 GPT-4 Turbo	1 token
🔵 GPT-4.1	3 tokens
🟣 GPT-4o	5 tokens

2. Key Features

Instant AI snippets for Posts, Pages, WooCommerce Products & Categories.
Bulk generation directly from list tables with a Generate with AI bulk action.
Quick Filters on Posts list (Has/Missing KW, Poor/Fair/Excellent).
Colour-coded Snippet Score calculated on six industry-standard criteria.
Custom prompt field to inject brand tone or extra guidelines.
Model picker (Turbo / 4.1 / 4o) with greyed-out tiers that unlock as you upgrade.
Index / No-index toggles for every content type.
Automatic slug rewrite with 301 redirect (optional).
Usage dashboard inside your RankPilotAI account.

3. System Requirements

WordPress 5.8 or later
PHP 7.4+
A RankPilotAI account (Free or Paid)
An active Site Key with available tokens

4. Installation

Download the ZIP from your RankPilotAI dashboard.
In WordPress go to Plugins → Add New → Upload, choose the ZIP and click Install Now.
Activate the plugin.
Go to AI Snippet SEO Pro in the sidebar, paste your Site Key and click Save.

Tip: On first activation the plugin generates a placeholder key for convenience; swap it with the real Site Key from your RankPilotAI dashboard before you start generating.

5. Licensing & Tokens

Every generation deducts 1–5 tokens depending on the model you pick (see §1).

Plan	Included Tokens
Free	25 complimentary tokens
Starter	100 tokens / month
Creator	400 tokens / month
Expert	1,200 tokens / month
Token Packs	One-off lifetime top-ups (100 → 5,000)

When tokens reach 0 the UI will show “No tokens left” and generation is blocked until you top-up.

6. Quick-Start Workflow

Action	Where	Steps
Single Post / Page	Edit screen	Click Generate with AI → wait ~5 s → fields auto-populate & score updates.
Bulk Posts	Posts → All Posts	Select rows → Bulk actions → Generate with AI Snippet SEO Pro → Apply.
Bulk Categories / Tags	Posts → Categories (Categories, Tags, WooCommerce Product Categories/Tags)	Same as above.

7. The Meta Box Explained

Field	Purpose	Best-practice rule
Focus Keyword	Primary keyword(s), comma-separated	Must appear verbatim in Title and Description
SEO Title	`<title>` element	30–60 characters
Meta Description	`<meta name="description">`	120–160 characters
Snippet Score	Quality meter (0–100)	≥ 67 = Fair, 100 = Excellent

The colour bars and live checklist update in real time as you type or when AI fills the fields.

8. SEO Settings

Setting	Description
GPT Model	Turbo (fast, cheap), 4.1 (balanced) or 4o (premium).
Custom Prompt	Optional extra instructions appended to RankPilotAI’s expert prompt.
Index?	Tells search engines to index or no-index each content-type.
Auto-update URL Slug	Overwrite slug with AI suggestion and create a 301 redirect automatically.

Greyed-out options indicate a plan upgrade is required.

Note: 301 redirect is automatic for posts/pages only. For taxonomies, manage redirects separately.

9. RankPilotAI Account Dashboard

Navigate to Account Dashboard → AI Snippet SEO Pro → Usage.
View per-site usage, remaining pool and progress bar.
Click Buy Tokens or Upgrade Plan when you’re running low.

10. Troubleshooting

Symptom	Likely Cause	Fix
“No Site Token configured” notice	Site Key field empty	Paste your key & save.
“No tokens left. Please upgrade.”	Token pool exhausted	Buy a pack or upgrade plan.
“Not enough tokens for the selected model”	Chosen model costs more tokens than you have	Select a cheaper model (e.g. GPT-4 Turbo) or add tokens.
Connection error to API	Firewall / wrong HTTPS	Whitelist `rankpilotai.com` and verify SSL.
Greyed-out GPT-4o option	Plan doesn’t include 4o	Upgrade to Creator / Expert.

11. Frequently Asked Questions

Does it overwrite Yoast or Rank Math fields?

No. AI Snippet SEO Pro uses its own independent meta box and custom fields. It does not write into Rank Math or Yoast fields.
To write directly into Rank Math fields, use our AI Snippet SEO Helper plugin instead.

Can I customise the prompt for a single post?

Not currently. Custom Prompt is configured globally under Settings → Custom Prompt.

How are tokens counted on bulk runs?

One deduction per item successfully processed; failures do not reduce tokens.

12. Changelog (excerpt)

v 4.0 – Model picker, token costs 1-3-5, slug auto-rewrite, multi-taxonomy bulk gen.
v 3.5 – Snippet Score in post list + sorting.
v 3.0 – RankPilotAI usage dashboard integration.
v 2.x – Token packs & PMPro tiers.
v 1.0 – Initial release.

13. Developer Hooks

Hook	Type	When it fires
`wp_ajax_aissp_generate_snippet`	Ajax action	Triggered during single-post generation.
`wp_ajax_aissp_bulk_tick` / `wp_ajax_aissp_bulk_cancel`	Ajax actions	Bulk job processor / cancel.
`aissp_http_args`, `aissp_http_retry_codes`, `aissp_http_retries`, `aissp_http_result`	Filters	Tweak JSON HTTP request args & retry behaviour.
`aissp_bulk_endpoint`	Filter	Override `/snippet-bulk` endpoint URL.
`aissp_calc_score`	Filter	Modify the calculated score/color result.

14. Prevent Rank Math from Overriding Your Snippets

Recommended: Use Rank Math together with AI Snippet SEO Helper for meta titles & descriptions. If you still prefer AI Snippet SEO Pro to output the meta tags while keeping Rank Math for schema/analytics, add the filters below to your site’s functions.php (or place them in a small must-use/custom plugin).

Add to functions.php

add_filter('rank_math/frontend/title', '__return_empty_string');
add_filter('rank_math/frontend/description', '__return_empty_string');

This disables Rank Math’s title and description output while keeping other SEO features intact.

15. Support

Docs & FAQs: rankpilotai.com/docs
Email: [email protected]
Slack: #rankpilotai-support

Feel free to reach out—our team will be happy to help you boost your on-page SEO with AI!

↑ Top