/
SN
snowseo
/
SnowSEO API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 5h ago · Updated 5h ago
latest
OpenAPI 3.0.0
2026-08-21
509
0
368.2 KB
c8f1f876a92c
Activity Feed
1
get
Get activity feed
AI Models
4
get
List AI visibility models
patch
Update AI visibility model state
get
Get AI visibility refresh interval
patch
Set AI visibility refresh interval
AI Tracker
20
post
Create or bulk-create tracked prompts
delete
Delete one or many tracked prompts
patch
Update one or many tracked prompts
post
Refresh a prompt and all its region variants
post
Refresh many prompts and their region variants
delete
Delete specific responses for a prompt
post
Generate query variations from a seed query
get
AI Visibility filter dropdown options
get
AI visibility headline metrics
get
AI visibility overview (leaderboard, trends, comparison)
get
AI visibility trend lines
get
Brand leaderboard across the filtered dataset
get
Single brand summary across the filtered dataset
get
Tracked competitor comparison
get
Sources AI engines cite when answering about the brand
get
AI answers that cited a source (provenance)
get
Per-AI-platform visibility rollup
get
Sentiment evidence behind the brand's AI sentiment score
get
Tracked prompts with per-prompt visibility metrics
get
One tracked prompt in detail
Autumn
2
get
Credit top-up price ladder
get
List products
Billing
2
get
Get credit usage history
get
Get per-day credit usage buckets for the chart
Bing Webmaster Tools
4
get
Get Bing search queries
get
Get Bing traffic stats
get
Get Bing top pages
get
Get Bing backlinks
Changelogs
7
get
Get changelog entries for a year or a single month
get
Get a day-aligned page of changelog entries
get
Get the complete list of months that have changelog entries
get
Get a single changelog entry by slug
get
Get days of changelog entries promoted to the dashboard
get
Get every announcement published on one day, bodies included
post
Dismiss dashboard announcements
CMS
24
get
List articles
post
Create an article (draft) from a pre-built outline
get
Get article by slug
delete
Delete an article
patch
Update an article
post
Reset changes to the content snapshot
patch
Set article public feed visibility
get
Get outbound internal links for an article
get
Get all internal links for a team
post
Schedule an article for publishing
delete
Unschedule one or many articles
post
Publish one or many articles to a CMS provider
post
Unpublish one or many articles from a CMS provider
put
Set article categories (full replace)
put
Set article tags (full replace)
post
Auto-optimize an article
post
Import an article from a URL, raw HTML, or Markdown
get
Get latest article audit
get
Get article audit history
get
List the team's reusable categories + tags
post
Refresh taxonomy from connected CMS providers
post
Create a team category or tag
delete
Delete a team category or tag (removes it from all articles)
patch
Rename a team category or tag (merges on name collision)
Crawl Settings
3
get
Get the team's crawl settings
patch
Update the team's crawl settings
post
Re-read the site's sitemaps
Free Tools
46
post
AI Detector
get
AI Detector usage
post
AI Readiness Analyzer
get
AI Readiness usage
post
Article Summarizer
get
Article Summarizer usage
post
Backlink Checker
get
Backlink Checker usage
post
Blog Outline Generator
get
Blog Outline Generator usage
post
Blog Post Ideas Generator
get
Blog Post Ideas usage
post
Content Idea Generator
get
Content Idea Generator usage
get
Copywriting Generator usage
post
Domain Rating Checker
get
Domain Rating Checker usage
post
GEO Analysis
get
GEO Analysis usage
post
Image Alt Tag Generator
get
Image Alt Tag Generator usage
post
JSON-LD Generator
get
JSON-LD Generator usage
post
Free Keyword Research
get
Keyword Research usage
post
LLMs Txt Generator
get
LLMs Txt Generator usage
post
Meta Description Generator
get
Meta Description Generator usage
post
Meta Title Generator
get
Meta Title Generator usage
post
Page Speed Analyzer
get
Page Speed usage
post
Simplify Text
post
Rewrite Sentence
post
Readability Check via Crawl
post
Readability Analyze Text
get
Readability Check usage
post
Audit Website URL for SEO
get
SEO Audit usage
post
Sitemap Checker
get
Sitemap Checker usage
post
Sitemap Validator
get
Sitemap Validator usage
post
XML Sitemap Generator
get
XML Sitemap Generator usage
Free Tools (Copywriting)
3
post
Copywriting Generator
post
Copywriting - Reroll Sentence
post
Copywriting - Scrape Website
Generate Article
10
post
Generate a full article from a brief (one-shot)
get
Suggest internal links for an article
get
Generate target keywords for an article
get
Generate a structured, type-specific article outline
get
Generate FAQ-style prompts for an article
get
Generate article title ideas
get
Article generation status
get
Live generation event stream (NDJSON keep-alive)
get
Find competitor articles for a topic
post
Start article generation
GEO Audit
4
get
Get the site-wide GEO audit result
post
Run a site-wide GEO audit
get
List GEO scores per page
get
Get one page's full GEO audit
Google Analytics
14
get
Get GA traffic overview
get
Get GA engagement metrics
get
Get GA chart data
get
Get GA traffic sources
get
Get GA traffic channels
get
Get GA country breakdown
get
Get GA pages
get
Get GA devices
get
Get GA browsers
get
Get GA operating systems
get
Get GA average session duration
get
Get GA new vs returning users
get
Get GA campaigns
get
Get GA filter values
Google Search Console
7
get
Get Search Console top pages
get
Get Search Console page changes
get
Get Search Console search queries
get
Get Search Console pages for keyword
get
Get Search Console keyword position history for a page
get
Get Search Console device breakdown
get
Get Search Console country breakdown
GSC
1
get
Get GSC traffic stats
keyword-research
1
get
Generate keyword ideas
keywords
1
get
AI-powered keyword suggestions
MCP
2
get
List teams available to the MCP user
get
List integrations for a team
Next Steps
13
get
List Next Steps
post
Add a Next Step
post
Add several Next Steps
get
Get Next Step fix detail
patch
Edit a Next Step
post
Mark a Next Step done
post
Dismiss a Next Step
post
Dismiss one topic from a grouped Next Step
post
Snooze a Next Step
post
Start a Next Step
post
Reopen a Next Step
patch
Update a Next Step priority
post
Refresh Next Steps
notifications
3
get
List notifications
post
Mark specific notifications seen
post
Mark all notifications seen
Onboarding
3
get
List content planner items
patch
Update a content planner item
delete
Unschedule a content planner item
Organization
1
get
Organization brands overview
PageSpeed
5
post
Run a PageSpeed audit
get
Get the resources behind one PageSpeed issue on a page
get
Get one page's PageSpeed result
get
Get site-wide PageSpeed issues
get
List PageSpeed scores for every page
PDF Export
3
post
Generate an SEO audit PDF report
post
Queue a PDF export
get
Check a queued PDF export
PostHog
13
get
Get PostHog page counts
get
Get PostHog traffic sources
get
Get PostHog country breakdown
get
Get PostHog devices
get
Get PostHog browsers
get
Get PostHog operating systems
get
Get PostHog pages
get
Get PostHog new vs returning users
get
Get PostHog chart data
get
Get PostHog average duration
get
Get PostHog campaigns
get
Get PostHog traffic channels
get
Get PostHog filter values
Rank Tracking
8
post
Untrack one or more keywords
post
Delete one or more tracked keywords
get
List tracked keywords
post
Add one or more tracked keywords
patch
Update a tracked keyword
get
Top keywords from GSC
get
Keyword performance changes
get
Keyword position history
SEO Audit
10
get
Perform a comprehensive SEO audit on a website
post
Perform a comprehensive SEO audit on a website
get
Check whether an audit is already running
get
Get audit job progress
get
Get the latest SEO audit for a page or site
patch
Mark one page's SEO issue fixed
post
Auto-fix SEO issues on pages
get
Check auto-fix progress
patch
Mark an SEO issue fixed across the site
get
List crawled pages for a site
Settings
17
get
Get article automation settings
patch
Update article automation settings
get
List topic clusters available for automation
get
Get brand settings
patch
Update brand settings
patch
Update white-label report branding
get
Get custom SMTP settings
patch
Update custom SMTP settings
get
Get audience settings
patch
Update audience settings
get
List brand competitors
patch
Replace brand competitors
get
Get brand domain rating
get
Get notification settings
patch
Update notification settings
get
List content strategies (actions)
patch
Toggle a content strategy
Sitemaps
4
get
List the site's sitemaps
get
Get sitemap status from Google Search Console
post
Generate an XML sitemap for the site
post
Submit a sitemap to Google Search Console
Topic Clusters
33
post
Suggest keyword topic groupings
post
Queue an AI keyword grouping run
get
Live keyword grouping run for this team
get
Status of one keyword grouping job
post
Notify me when this grouping run finishes
post
Apply keyword groupings transactionally
get
List topic clusters
post
Create a topic cluster
get
Check cluster containment
get
Get linked keywords and prompts
get
Batch get links for all clusters
get
Get topic cluster details
delete
Delete a topic cluster
patch
Rename a topic cluster
post
Add keyword to topic cluster
post
Move a keyword to another topic cluster
post
Move multiple keywords to another topic cluster
post
Remove multiple keywords from a topic cluster
post
Add prompts to a topic cluster
post
Move a prompt to another topic cluster
post
Move multiple prompts to another topic cluster
post
Remove multiple prompts from a topic cluster
patch
Update tracking for a topic cluster
patch
Batch update tracking for multiple topic clusters
patch
Update active state of a prompt in a topic cluster
delete
Remove a keyword from a topic cluster
delete
Remove a prompt from a topic cluster
get
Topic map with live coverage
post
Refresh topic map snapshot
post
Generate net-new opportunities for a topic
post
Add a suggested opportunity to a topic
post
Resolve clicked source context
post
Generate schedule-ready article candidates
URL Inspection
5
post
Inspect a single URL's Google index status
get
Get Google index coverage tally
get
List per-URL Google index verdicts
post
Run a background Google index check
get
Check background index-check job status
Utilities
2
get
/docs/json
get
Search locations for local rank tracking (city/county/region/country)
get
/v3/api/auth/{wildcard}
post
/v3/api/auth/{wildcard}
get
/.well-known/oauth-authorization-server
get
/.well-known/oauth-authorization-server/{wildcard}
get
/.well-known/openid-configuration
get
/.well-known/openid-configuration/{wildcard}
get
/
get
/health
get
/v3/admin/queues/workbench
post
/v3/admin/queues/workbench/api/refresh
get
/v3/admin/queues/workbench/api/overview
get
/v3/admin/queues/workbench/api/counts
get
/v3/admin/queues/workbench/api/runs
get
/v3/admin/queues/workbench/api/schedulers
post
/v3/admin/queues/workbench/api/test
get
/v3/admin/queues/workbench/api/queue-names
get
/v3/admin/queues/workbench/api/queues
get
/v3/admin/queues/workbench/api/metrics
get
/v3/admin/queues/workbench/api/activity
get
/v3/admin/queues/workbench/api/queues/{name}/jobs
get
/v3/admin/queues/workbench/api/jobs/{queue}/{id}/logs
get
/v3/admin/queues/workbench/api/jobs/{queue}/{id}
post
/v3/admin/queues/workbench/api/jobs/{queue}/{id}/retry
post
/v3/admin/queues/workbench/api/jobs/{queue}/{id}/remove
post
/v3/admin/queues/workbench/api/jobs/{queue}/{id}/promote
post
/v3/admin/queues/workbench/api/schedulers/{queue}/{key}/run
get
/v3/admin/queues/workbench/api/search
get
/v3/admin/queues/workbench/api/tags/{field}/values
post
/v3/admin/queues/workbench/api/queues/{name}/clean
post
/v3/admin/queues/workbench/api/bulk/retry
post
/v3/admin/queues/workbench/api/bulk/delete
post
/v3/admin/queues/workbench/api/bulk/promote
post
/v3/admin/queues/workbench/api/queues/{name}/pause
post
/v3/admin/queues/workbench/api/queues/{name}/resume
get
/v3/admin/queues/workbench/api/flows
post
/v3/admin/queues/workbench/api/flows
get
/v3/admin/queues/workbench/api/flows/{queueName}/{jobId}
get
/v3/admin/queues/workbench/config
get
/v3/admin/queues/workbench/assets/{file}
get
/v3/admin/queues/workbench/app-icon.svg
get
/v3/admin/queues/workbench/{wildcard}
get
/v3/admin/cms-editor/media
post
/v3/admin/cms-editor/copilot
post
/v3/appsumo/link
get
/v3/billing/feature-check/
get
/v3/billing/lock-status/
get
/v3/billing/plan-status/
post
/v3/billing/previewAttach/
post
/v3/billing/previewUpdateSubscription/
post
/v3/billing/updateSubscription/
post
/v3/cms/editor/copilot
post
/v3/contact/
get
/v3/custom-domains/
post
/v3/custom-domains/
delete
/v3/custom-domains/
post
/v3/custom-domains/verify
patch
/v3/custom-domains/path-prefix
patch
/v3/custom-domains/settings
get
/v3/custom-domains/resolve
get
/v3/custom-domains/authorize
get
/v3/feed/{brandSlug}
get
/v3/feed/{brandSlug}/rss.xml
get
/v3/feed/{brandSlug}/{articleSlug}
post
/v3/generate-ai-image/
post
/v3/generate-article/check-cannibalization/
get
/v3/generate-article/plan-topic/
post
/v3/generate-article/reangle/
post
/v3/generate-jsonld/
post
/v3/generate-tldr/
get
/v3/geo-audit/active-job
get
/v3/geo-audit/job-status
get
/v3/integrations/bing/connect
post
/v3/integrations/bing/disconnect
get
/v3/integrations/bing/
get
/v3/integrations/bing/properties
post
/v3/integrations/bing/set-property
get
/v3/integrations/framer/
post
/v3/integrations/framer/connect
post
/v3/integrations/framer/disconnect
post
/v3/integrations/framer/server-api/connect
get
/v3/integrations/framer/server-api/collections
post
/v3/integrations/framer/server-api/configure
post
/v3/integrations/ga/connect
post
/v3/integrations/ga/disconnect
get
/v3/integrations/ga/get
patch
/v3/integrations/ga/property
get
/v3/integrations/ghost/
post
/v3/integrations/ghost/connect
post
/v3/integrations/ghost/disconnect
get
/v3/integrations/gmail/connect
post
/v3/integrations/google-pagespeed/connect
get
/v3/integrations/google-pagespeed/
post
/v3/integrations/google-pagespeed/disconnect
get
/v3/integrations/grigora/
post
/v3/integrations/grigora/connect
post
/v3/integrations/grigora/disconnect
get
/v3/integrations/gsc/connect
post
/v3/integrations/gsc/disconnect
get
/v3/integrations/gsc/
get
/v3/integrations/gsc/properties
patch
/v3/integrations/gsc/property
post
/v3/integrations/indexnow/connect
get
/v3/integrations/indexnow/
post
/v3/integrations/indexnow/verify
post
/v3/integrations/indexnow/disconnect
post
/v3/integrations/indexnow/submit
get
/v3/integrations/outlook/connect
post
/v3/integrations/plausible/connect
get
/v3/integrations/plausible/
post
/v3/integrations/plausible/disconnect
get
/v3/integrations/plausible/analytics
get
/v3/integrations/plausible/chart/
get
/v3/integrations/plausible/sources/
get
/v3/integrations/plausible/countries/
get
/v3/integrations/plausible/devices/
get
/v3/integrations/plausible/browsers/
get
/v3/integrations/plausible/os/
get
/v3/integrations/plausible/pages/
get
/v3/integrations/plausible/user-type/
get
/v3/integrations/plausible/avg-duration/
get
/v3/integrations/plausible/campaigns/
get
/v3/integrations/plausible/channels/
get
/v3/integrations/plausible/filter-values/
post
/v3/integrations/posthog/connect
get
/v3/integrations/posthog/
post
/v3/integrations/posthog/disconnect
get
/v3/integrations/shopify/
post
/v3/integrations/shopify/connect
post
/v3/integrations/shopify/configure
post
/v3/integrations/shopify/blogs/refresh
post
/v3/integrations/shopify/disconnect
get
/v3/integrations/webflow/
post
/v3/integrations/webflow/connect
post
/v3/integrations/webflow/switch
post
/v3/integrations/webflow/configure
post
/v3/integrations/webflow/refresh-collections
post
/v3/integrations/webflow/disconnect
get
/v3/integrations/wordpress/
post
/v3/integrations/wordpress/connect
post
/v3/integrations/wordpress/disconnect
post
/v3/integrations/wordpress/generate-key
get
/v3/integrations/wordpress/connection-status
get
/v3/integrations/wordpress/latest-version
post
/v3/integrations/wordpress/plugin-disconnect
post
/v3/newsletter/subscribe
get
/v3/notes/
post
/v3/notes/
put
/v3/notes/{id}
delete
/v3/notes/{id}
get
/v3/onboarding/authority-map
get
/v3/onboarding/generate-description
get
/v3/onboarding/generate-target-audience
get
/v3/onboarding/intermediate-results
get
/v3/onboarding/region-search
get
/v3/onboarding/suggest-competitors
get
/v3/onboarding/suggest-questions
get
/v3/onboarding/suggest-topics
get
/v3/onboarding/verify-brand
get
/v3/onboarding/post-onboarding/status
post
/v3/onboarding/post-onboarding/initiate
post
/v3/onboarding/post-onboarding/save-content-calendar
patch
/v3/onboarding/post-onboarding/survey
post
/v3/onboarding/post-onboarding/content-planner/from-topic-map
post
/v3/onboarding/post-onboarding/content-planner/{slug}/generate-now
post
/v3/onboarding/post-onboarding/content-planner/generate-next-30-days
get
/v3/onboarding/post-onboarding/content-planner/generate-next-30-days/status
get
/v3/onboarding/user/recover
get
/v3/onboarding/user/status
post
/v3/onboarding/user/partial-save
post
/v3/onboarding/user/final-save
post
/v3/onboarding/user/complete-with-plan
post
/v3/onboarding/user/geo-audit-public-visibility
post
/v3/organization/add-member-to-team
get
/v3/organization/agency-toggle
patch
/v3/organization/agency-toggle
get
/v3/organization/check-slug
patch
/v3/organization/{teamId}/archive
get
/v3/organization/{invitationId}
post
/v3/organization/logo
patch
/v3/organization/{memberId}/role
post
/v3/organization/portfolio/refresh
delete
/v3/organization/{memberId}
get
/v3/organization/teams-with-members
post
/v3/organization/invitations/{invitationId}/validate-cancel
get
/v3/page-speed/active-job
get
/v3/page-speed/job-status
post
/v3/page-speed/site-fix
post
/v3/page-speed/site-fix/revert
get
/v3/page-speed/site-fix/capability
get
/v3/page-speed/site-fix/status
get
/v3/public/article-share/{token}
patch
/v3/public/article-share/{token}
post
/v3/public/article-share/{token}/submit
post
/v3/public/article-share/{token}/unsubmit
get
/v3/public/geo-audit-result/
get
/v3/public/report-share/{token}
get
/v3/public/sitemap/{teamId}/sitemap.xml
get
/v3/public/sitemap/{teamId}/{file}
get
/v3/rank-tracking/distribution-trend
get
/v3/reports/
post
/v3/reports/
get
/v3/reports/templates
get
/v3/reports/{id}
delete
/v3/reports/{id}
patch
/v3/reports/{id}
get
/v3/reports/{id}/share
post
/v3/reports/{id}/share/email
post
/v3/reports/{id}/share/link
delete
/v3/reports/share/{token}
post
/v3/reports/translations/
get
/v3/repurpose-content/
post
/v3/resolve-media-placeholders/
delete
/v3/seo-audit/crawled-pages/
get
/v3/seo-optimization/optimize-field
post
/v3/settings/brand/upload
post
/v3/settings/brand/smtp/test
delete
/v3/settings/brand/screenshot
patch
/v3/settings/brand/screenshot
post
/v3/settings/brand/screenshots
delete
/v3/settings/brand/screenshots/{screenshotLabel}
patch
/v3/settings/brand/screenshots/{screenshotLabel}
post
/v3/settings/brand/suggest-competitors
get
/v3/settings/brand/discovered-competitors
get
/v3/settings/brand/knowledge-base/{id}
post
/v3/settings/brand/knowledge-base/file
get
/v3/url-inspection/job-status
post
/v3/user/avatar
get
/v3/user/data-export/
post
/v3/user/data-export/
get
/v3/user/data-export/{id}
get
/v3/user/data-export/{id}/download
get
/v3/user/marketing-preferences/
patch
/v3/user/marketing-preferences/
Utilities
OpenAPI specification for SnowSEO API.
get
/docs/json
Response
Default Response