snowseo-api API reference · SKMTC Hub

/

/SnowSEO API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v5

OpenAPI 3.0.02026-08-034760291.5 KB

Utilities

OpenAPI specification for SnowSEO API.

get/docs/json

Response

Default Response

All 476 operations

get /docs/json
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 Get activity feed
get /v3/admin/cms-editor/media
post /v3/admin/cms-editor/copilot
get List AI visibility models
patch Update AI visibility model state
get Get AI visibility refresh interval
patch Set AI visibility refresh interval
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
delete Delete specific responses for a prompt
post Generate query variations from a seed query
get Unified AI Visibility view (sectioned)
get Single brand summary across the filtered dataset
get AI answers that cited a source (provenance)
get AI Visibility filter dropdown options
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/
get List products
post /v3/billing/updateSubscription/
get Get credit usage history
get Get per-day credit usage buckets for the chart
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 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
post /v3/cms/editor/copilot
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)
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 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
post Copywriting Generator
post Copywriting - Reroll Sentence
post Copywriting - Scrape Website
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
post /v3/generate-ai-image/
post /v3/generate-article/check-cannibalization/
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
get /v3/generate-article/plan-topic/
post /v3/generate-article/reangle/
post Start article generation
post /v3/generate-jsonld/
post /v3/generate-tldr/
get /v3/geo-analysis/
get /v3/geo-audit/site
post /v3/geo-audit/site
get /v3/geo-audit/pages
get /v3/geo-audit/page
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 Get Bing search queries
get Get Bing traffic stats
get Get Bing top pages
get Get Bing backlinks
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 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
get /v3/integrations/ghost/
post /v3/integrations/ghost/connect
post /v3/integrations/ghost/disconnect
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
get Get GSC traffic stats
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
post /v3/integrations/indexnow/connect
get /v3/integrations/indexnow/
post /v3/integrations/indexnow/verify
post /v3/integrations/indexnow/disconnect
post /v3/integrations/indexnow/submit
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 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
get /v3/integrations/shopify/
post /v3/integrations/shopify/connect
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
get /v3/jobs/run/status
get /v3/jobs/run/status/batch
get Generate keyword ideas
get /v3/keyword-research/suggest-keywords
get AI-powered keyword suggestions
get List teams available to the MCP user
get List integrations for a team
post /v3/newsletter/subscribe
get List Next Steps
get Get Next Step fix detail
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
post Refresh Next Steps
get /v3/notes/
post /v3/notes/
put /v3/notes/{id}
delete /v3/notes/{id}
get List notifications
post Mark specific notifications seen
post Mark all notifications seen
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
get List content planner items
post /v3/onboarding/post-onboarding/save-content-calendar
patch /v3/onboarding/post-onboarding/survey
patch Update a content planner item
delete Unschedule a content planner item
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
get Organization brands overview
post /v3/organization/portfolio/refresh
delete /v3/organization/{memberId}
get /v3/organization/teams-with-members
post /v3/organization/invitations/{invitationId}/validate-cancel
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}
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 /v3/rank-tracking/distribution-trend
get Top keywords from GSC
get Keyword performance changes
get Keyword position history
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/
get /v3/seo-optimization/optimize-field
get Get article automation settings
patch Update article automation settings
get List topic clusters available for automation
post /v3/settings/brand/upload
get Get brand settings
patch Update brand settings
patch Update white-label report branding
get Get custom SMTP settings
patch Update custom SMTP settings
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}
get Get audience settings
patch Update audience settings
get List brand competitors
patch Replace brand competitors
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 Get notification settings
patch Update notification settings
get List content strategies (actions)
patch Toggle a content strategy
post Suggest keyword topic groupings
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
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/
get Perform a comprehensive SEO audit on a website
post Perform a comprehensive SEO audit on a website
get /v3/website-audit/active-job
get /v3/website-audit/crawl-settings/
patch /v3/website-audit/crawl-settings/
post /v3/website-audit/crawl-settings/refresh
get /v3/website-audit/latest-audit/
patch /v3/website-audit/audit-issues/{id}/mark-fixed
post /v3/website-audit/audit-issues/autofix
get /v3/website-audit/audit-issues/autofix/status
patch /v3/website-audit/audit-issues/mark-all-fixed
get /v3/website-audit/crawled-pages/
post Generate a website audit PDF report
post /v3/website-audit/page-speed/run
get /v3/website-audit/page-speed/active
get /v3/website-audit/page-speed/issue-details
get /v3/website-audit/page-speed/
get /v3/website-audit/page-speed/issues-summary
get /v3/website-audit/page-speed/list
get /v3/website-audit/sitemaps/
get /v3/website-audit/sitemaps/gsc
get /v3/website-audit/sitemaps/pages
post /v3/website-audit/sitemaps/generate
post /v3/website-audit/sitemaps/submit-gsc
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
post Queue a website audit PDF export
get Check a queued PDF export