Documentation

Getting Started

Learn how to integrate SEO Sniper into your website and start generating AI-powered, SEO-optimized content in minutes.

Quick Start Guide

1

Create Your Account

Sign up for SEO Sniper and complete the onboarding process. You will get access to your dashboard where you can manage all your sites and content.

Create Account
2

Run the Onboarding Wizard

When you add a site, our onboarding wizard walks you through declaring your website type (WordPress, web app, static site, or website builder), hosting preference, and domain setup. It auto-routes you to the right integration path so you never see options that don't fit your platform. The wizard also offers a one-click Google Search Console connection during onboarding — clicking Connect opens Google's consent screen in a new tab while you finish the wizard in the original tab.

Example:

https://yourdomain.com

Tip: A clear, specific business description (what you offer, who you serve, where you operate) becomes the primary signal for every AI feature in the app — keyword recommendations, topic ideas, and article generation are all grounded in it.

3

Add Your Keywords

Enter your target keywords that you want to rank for, or let our AI auto-detect them from your business description + Google Search Console data. We also surface weekly keyword opportunities based on gap analysis between what you target and what Google is already showing you for.

best coffee shop austin
specialty coffee beans
local coffee roasters

Tip: Use long-tail keywords for better targeting and less competition.

4

Generate Your Article

Click the "Generate Article" button to create your first AI-powered, SEO-optimized article. The AI will use your keywords, business context, and selected tone to craft compelling content.

~30 seconds
Credits vary by word count
5

Generate an API Token

Go to Settings → Integrations and create an API token for your site. This token authenticates your external website to fetch articles from SEO Sniper.

Token format:

sst_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Keep your token secret - it grants read access to your articles
6

Integrate with Your Site

Choose your integration method based on your website platform. Your articles are fetched via our API and appear only on YOUR site, not on our platform.

WordPressStatic SitesWeb Apps

API Integration

SEO Sniper provides a REST API to fetch your published articles. Each article includes raw HTML, pre-styled HTML, metadata, and SEO tags. Your token automatically filters to only your site's articles.

List Articles

bash
curl "https://YOUR_CONVEX_URL/api/v1/articles" \
  -H "Authorization: Bearer sst_YOUR_TOKEN"

Replace YOUR_CONVEX_URL with your deployment URL (found in Settings → Integrations).

Get Single Article

bash
curl "https://YOUR_CONVEX_URL/api/v1/articles/your-article-slug" \
  -H "Authorization: Bearer sst_YOUR_TOKEN"

Response Format

json
{
  "articles": [
    {
      "id": "abc123...",
      "slug": "best-coffee-shops-austin",
      "title": "10 Best Coffee Shops in Austin",
      "metaTitle": "Best Coffee Shops Austin | Local Guide",
      "metaDescription": "Discover the top coffee shops...",
      "contentHtml": "<h1>10 Best Coffee Shops...</h1>...",
      "styledContentHtml": "<h1 style=\"...\">...</h1>...",
      "contentMarkdown": "# 10 Best Coffee Shops...",
      "featuredImageUrl": "https://...",
      "featuredImageAlt": "Coffee shop interior",
      "publishedAt": "2024-01-15T10:30:00.000Z",
      "wordCount": 1500,
      "keywordsUsed": ["coffee shops", "austin"],
      "blogStyle": {
        "template": "modern",
        "customCss": null,
        "stylingMethod": "inline"
      }
    }
  ],
  "pagination": { "total": 25, "offset": 0, "limit": 10, "hasMore": true }
}

Key fields:

  • contentHtml - Raw HTML content
  • styledContentHtml - HTML with styles pre-applied (based on your settings)
  • contentMarkdown - Markdown source for custom rendering

Key Features

SEO Optimization

Every article includes optimized meta titles, descriptions, and proper heading structure for maximum search visibility.

AI-Powered Content

GPT-4 powered content generation ensures high-quality, engaging articles tailored to your brand voice.

Auto-Scheduling

Set up automatic article generation on a daily or weekly schedule to maintain consistent content output.

Internal Linking

Automatic internal link suggestions help build a strong site structure and improve SEO performance.

Next Steps

Set up WordPress integrationIntegrate with static websitesCustomize your blog styling
SEO Sniper