Share the website, target market, and desired outcome.
SEO data and workflows for Codex
Make AI Your SEO SpecialistPut AI to Work on Your Independent Site
What is SEO Agent? It brings together Google Search and website performance data, with 7 Skills and 28 core capabilities spanning keyword research, competitor analysis, technical diagnostics, content creation, publishing, and performance monitoring. It helps independent-site operators execute SEO more efficiently and build stronger SEO expertise through day-to-day work.
Independent-site owners should spend their time growing the business, not untangling complex SEO problems. Let SEO Agent handle the repetitive work and keep professional optimization moving your site forward.
What SEO Agent can do
SEO work that SEO Agent can handle automatically
7 Skills and 28 core capabilities
How a real task gets completed
You set the goal. Codex and SEO Agent turn it into a measurable result.
You do not need to choose a technical tool first. Each stage shows its evidence, and any website change or publication waits for your approval.
Use data to decide which opportunities deserve attention first.
Technical findings become a clear action list.
You stay in control of every important change.
Get started in three steps
Connect once, then describe every SEO goal in Codex
The How to Use page keeps the complete beginner setup for Codex, a model provider, and the SEO Agent MCP connection.
Install Codex and CC Switch, then configure a working model provider.
Create an account and API Key, then let Codex add the SEO Agent MCP server.
Describe the website, target market, and desired result. Codex chooses the right SEO capabilities.
Pricing and control
No monthly fee. Important actions require approval.
Your balance remains valid, and SEO data or workflow usage is charged based on actual use. Page edits and publishing pause until you review and approve the result.
Help
You don't need to know SEO to have AI optimize your website.
In Codex, clearly describe your website, market, and goals, and SEO Agent will help you research, explain issues, and organize action checklists. For batch tasks, you can also connect scripts and internal systems via API / MCP.
Product Features
Core capabilities currently available in SEO Agent
Usage Instructions
You can have Codex complete these tasks.
State the target clearly first
Enter your main site, landing pages, keywords, competitor domains, or brand name. The more complete the information, the closer the report will be to a deliverable solution.
Specify market scope
Indicate the target country, language, and search engine, e.g., US English Google, UK English Google, Bing, or the Chinese market.
Clarify business goals
Tell the Agent whether you care more about organic traffic, sales inquiries, landing page conversions, catching up with competitors, content topics, or technical fixes.
For batch tasks, use API / MCP
When you need to integrate Codex, internal systems, automation scripts, MCP clients, or batch data retrieval, go to the API / MCP page to view interfaces, MCP configuration, and request examples.
FAQ
Frequently Asked Questions (FAQ)
What is SEO Agent?+
SEO Agent is an engine that provides Codex with real SEO data, standard workflows, and website execution capabilities. As long as you clearly state your website, market, and business goals, Codex can use SEO Agent to look up data, identify issues, create content, and publish and continuously monitor after your confirmation.
What features does SEO Agent support?+
Supports natural language creation of SEO workflows, covering keyword research, SERP and ranking queries, competitor analysis, technical SEO, site architecture, page optimization, content generation, WordPress/CMS publishing, scheduled monitoring and notifications, GEO/AI search visibility, and diagnostics using authorized GSC/GA4 data.
How does billing work? Is there a monthly fee?+
SEO workflows are billed by stage, with keyword research, article generation, checks, publishing, and monitoring calculated separately. After recharging, charges are based on actual usage, with no monthly fee. You can view estimated costs before use, and stages that are not executed will not incur corresponding charges.
After connecting WordPress, can SEO Agent modify the website?+
It can modify post content that the authorized WordPress user has permission to manage, such as creating drafts and updating titles and body content. It will wait for user confirmation before publishing. SEO Agent currently does not modify themes, plugins, site settings, or server files; actual permissions are determined by the WordPress user account.
How do I integrate API or MCP?+
After logging in, create an API Key on the personal settings page, then go to the API / MCP page to review the REST APIs and MCP configuration instructions. Multiple interfaces are supported, including keywords, rankings, competitors, GEO, site audit, GSC search performance and advanced diagnostics, and GA4 traffic quality diagnostics. The API supports batch calls and cost estimation, and MCP can be directly connected to AI tools that support the MCP protocol, such as Codex.
How many pages can the site audit crawl?+
The site audit crawls 20 pages by default and supports up to 100 pages, with a maximum crawl depth of 5 levels. It can check technical SEO issues such as page status codes, title, meta description, H1-H6 headings, canonical, internal and external links, image alt text, content relevance, keyword coverage, duplicate content, noindex, structured data, and JS rendering.
What is GEO analysis? What can SEO Agent do?+
GEO (Generative Engine Optimization) focuses on the visibility of brands and content in AI search. SEO Agent uses the new LLM Mentions to query mentions, high-frequency sources, historical trends, new/lost, multi-target comparison, and brand-category landscape in Google AI Overview and ChatGPT, and can review page representation, public crawler rules, llms.txt, and structured data. The database sample does not query each model in real time one by one; llms.txt is also an optional experimental item and does not guarantee AI citations.
What is MCP? What is the difference between MCP and API?+
MCP (Model Context Protocol) is a protocol that allows AI tools to directly invoke external capabilities. With the API, you need to write code yourself to call and process data. After MCP is connected, AI tools that support MCP (such as Codex) can automatically understand your goals, proactively call SEO Agent's standardized data capabilities, and complete continuous workflows such as querying, organizing, and analyzing draft reports, without the need to manually switch tools or organize data.
Where does keyword data come from? How accurate is it?+
Keyword and ranking data comes from SEO Agent's standardized SEO data capabilities, covering major search engines and supporting multiple countries and languages globally. The data is updated frequently and includes rich dimensions such as search volume, competition, CPC, trends, and search intent, meeting the needs of professional SEO analysis.
How do I get started with SEO Agent?+
Get started in four steps: 1. Download Codex and CC Switch; 2. Configure a third-party relay service so Codex can chat normally; 3. Create an API Key in your profile and connect the SEO Agent MCP to Codex; 4. Use everyday language in Codex to describe your website, market, and goals.
What types of users is it suitable for?+
Suitable for SEO operations staff, standalone website sellers, and foreign trade companies. SEO operations staff can reduce repetitive work in checking data, organizing tables, and writing drafts; foreign trade business owners can reduce duplicate tools and outsourcing communication costs, and directly see evidence, actions, and progress.
Can I export data? What formats are supported?+
Supports exporting raw data tables in CSV format, and can also generate complete SEO consultant reports (Markdown format), including core findings, data evidence, impact analysis, priorities, and action lists. In addition, it can directly generate Title/Meta suggestions, FAQ content, Schema code, page module plans, llms.txt suggestions, and other ready-to-use deliverables.
How is it different from tools like Ahrefs, Semrush, etc.?+
Traditional SEO tools give you data and dashboards, and you need to analyze and organize the data yourself. SEO Agent is an AI-driven SEO consultant that not only provides data, but also helps you interpret data, discover opportunities, assess impact, prioritize, and generate executable plans and deliverables. It also supports MCP integration, allowing AI tools to directly call SEO capabilities and form automated workflows. The billing model is also more flexible, with pay-as-you-go pricing and no monthly fees.
Which countries and languages are supported for keyword queries?+
Supports the vast majority of countries and languages globally, including major markets such as the United States, the United Kingdom, Canada, Australia, Germany, France, Japan, South Korea, and China. When querying, you can specify country codes (e.g., us, gb, de, jp) and language codes (e.g., en, de, ja, zh) to obtain localized search data for the corresponding market.
How is the security of the API Key guaranteed?+
API Keys are stored encrypted, and the full key is only displayed once at creation time and cannot be viewed later. You can set different API permissions (scope), spending limits, and expiration dates for each key to reduce risk. Keys can be deactivated or deleted at any time. We recommend creating separate keys for different purposes and rotating them regularly.
Can I get a refund after recharging?+
In principle, recharged amounts are non-refundable, but if you encounter service failures or major usage issues, you can contact customer service for resolution. We recommend starting with a small recharge to try the service, and then recharging based on usage after confirming it meets your needs. Your balance is valid indefinitely and will not expire or be reset.
Recharge Center
Pay only for what you use, no monthly fee
For recharge, billing, or account issues, scan the QR code to contact customer service.
Order Confirmation
Confirm Recharge
Payment Method
Generating QR Code...
Please use WeChat to scan the QR code to complete the payment.
Payment Amount: $0.00
Waiting for payment...
Payment successful!
The top-up amount has been credited and your balance has been updated.
Account Management
Personal Settings
Manage your balance, API Keys, project profile, and account records.
API / MCP Usage
Create and manage API Keys here. MCP and API share the same Key: AI tools such as Codex use it to call MCP, while Python, automation scripts, or internal systems use it to call the API.
- New Keys have every endpoint enabled by default. Create separate Keys for different uses to keep them organized.
- SEO companies: It is recommended to create separate keys by client or delivery tool, making it easier to export records and troubleshoot.
- Foreign trade enterprises: create separate keys for Codex and internal scripts, and set quotas or expiration dates.
My API Keys
Affiliate Plan
This is your dedicated referral link. When someone registers through it, each future recharge generates commission at the rate set by the administrator.
Invited users and recharges
Google Data Connection
Manage GSC and GA4 authorizations centrally. Neither is required; connect whichever you need. Once connected, they can be used for API and MCP analysis.
GSC Search Performance
Keyword impressions, clicks, CTR, rankings, and page opportunities.
GA4 Traffic Quality
Channels, landing pages, engagement, key events, and conversion attribution.
Security tip: GSC / GA4 only reads the data you authorize. If no sites or properties appear after connecting, check the current Google account permissions. Codex or other MCP clients still only need the SEO Agent API Key.
Site Control Connections
Connect WordPress or Shopify to read and optimize site resources. Draft automation is enabled: after Codex explicitly confirms, eligible drafts and low-risk SEO text can run automatically; formal publishing and high-risk changes still require your confirmation.
Controlled automation
Managed SEO workspace
Read data, find opportunities, and check content automatically. Every CMS write requires your review and click.
Needs your attention
Open a site's edit tab to review every pending action in one place.
28-day trend
Daily snapshots, matched periods, and content events share one timeline.
Page changes
Prioritize existing-page growth, decay, and anomalies.
Opportunities
Improve existing pages first. New content needs independent intent and real evidence.
Content review
E-E-A-T is an evidence gate, not a Google score.
New keyword and long-tail discovery
Only the top 10 candidates per seed scoring at least 55 become admin-review opportunities.
Site page inventory
Sitemap and technical checks support duplicate-intent and internal-link decisions.
Verifiable site facts
First-party experience, credentials, product claims, and trust details need real sources.
Jobs, monitoring, and model status
Daily metrics, weekly opportunities, and post-publish reviews use a reliable queue.
Publishing and content events
Every remote write is clicked by an admin, idempotent, and audited.
SEO Project Profile
After saving, SEO Agent will combine your industry, target market, business goals, and competitors in future reports for analysis.
Change Password
Recharge History
Recent Spending History
For questions about recharges, charges, account, and usage, scan the QR code to contact customer service.
API / MCP Integration
Integrate SEO Agent with Codex, Scripts, and Internal Systems
API / MCP is for standalone website sellers, SEO agencies, and international businesses. You can use the same SEO Agent API Key to integrate MCP, API, GEO, keyword research, competitors, site audits, authorized GSC search performance, and authorized GA4 traffic quality data into Codex, client reports, databases, Python scripts, or internal automation workflows.
Choose an Integration Method First
MCP is suitable for letting AI tools directly handle continuous SEO tasks; API is suitable for your systems, scripts, or client reports to reliably pull standardized data. Both share the same SEO Agent API Key.
Capabilities
- MCP integration: lets AI tools like Codex call SEO Agent according to your goals without manually remembering API endpoints.
- API integration: plug standardized SEO data into scripts, internal systems, client reports, and automation workflows.
- GEO current visibility: check current mentions, metrics, and top sources in Google AI Overview or ChatGPT.
- GEO trend monitoring: view historical monthly trends, week/month/year changes, and gained or lost mentions.
- GEO competitive landscape: compare 2 to 10 brands, domains, or topics side by side, and query top brands and brand categories.
- GEO deep audit: check page citability, AI crawlers, llms.txt, Schema, brand platform recommendations, and optional PDF reports.
- Keyword research: query search volume, competition, related keywords, deduplicated results, and priority.
- Deep keyword research: complete with KD, CPC, trends, question keywords, commercial intent, page type, and keyword grouping.
- Domain-specific keyword opportunities: based on the target domain's existing rankings, decide which keywords should optimize existing pages and which should get new pages.
- Domain keywords: view the website's current organic ranking keywords and opportunities to improve.
- Competitor analysis: get competitor keyword gaps, top-ranking peers, and competitor keyword strategies.
- Ranking lookup: check the organic ranking of a specified domain for a specified keyword.
- Site audit: use the built-in crawler to check pages, links, content, duplicate content, and technical issues.
- GSC search performance: read clicks, impressions, CTR, and average position for authorized sites, and output keyword opportunities, page opportunities, period summaries, content decay, keyword cannibalization, and prioritized action plans.
- GA4 traffic quality: read sessions, users, channels, landing pages, engagement rate, bounce rate, and key events for authorized properties, and output landing page opportunities, channel diagnostics, and prioritized action plans.
- Cost estimation: use the estimate endpoint to estimate the maximum cost before running a query.
How to get started
Go to “API / MCP Usage” in “Profile” to create a key. Every endpoint is enabled by default; SEO agencies can create separate keys per client or tool, while foreign trade businesses can create separate keys for internal scripts and Codex to manage quotas and records.
Codex remote MCP integration
The new Codex can have the AI write the remote MCP configuration directly in the conversation, without needing to find the old MCP button or download a local startup script. Once configured, Codex will call SEO Agent capabilities as tasks require.
Send in the Codex conversation
After replacing the API Key, send it to Codex. It will append the configuration; the legacy MCP button is not needed.
Please append the SEO Agent remote MCP to ~/.codex/config.toml on your local machine, keep the existing config, and do not echo the API Key:
[mcp_servers.seoagent]
enabled = true
url = "https://www.seoagent.vip/mcp"
[mcp_servers.seoagent.http_headers]
Authorization = "Bearer YOUR_SEO_AGENT_API_KEY"
Supported MCP tools
seoagent_keyword_researchKeyword research.seoagent_keyword_intelligenceIn-depth keyword research and grouping.seoagent_domain_keyword_opportunitiesDomain-personalized keyword opportunities.seoagent_domain_keywordsDomain ranking keywords.seoagent_competitor_gapCompetitor keyword gaps.seoagent_competitor_keyword_strategyCompetitor keyword strategies.seoagent_serp_rank_queryKeyword ranking lookup.seoagent_geo_visibilityGEO visibility.seoagent_geo_visibility_historyAI visibility historical trend.seoagent_geo_visibility_deltaAI visibility change.seoagent_geo_visibility_new_lostAI new and lost mentions.seoagent_geo_visibility_comparisonAI visibility comparison for up to 10 targets.seoagent_geo_brand_landscapeAI top brands and brand-category landscape.seoagent_geo_deep_auditGEO deep audit.seoagent_site_auditSite audit.seoagent_gsc_sitesGSC authorized sites.seoagent_gsc_search_analyticsGSC search performance.seoagent_gsc_keyword_opportunitiesGSC keyword opportunities.seoagent_gsc_page_opportunitiesGSC page opportunities.seoagent_gsc_performance_summaryGSC performance summary.seoagent_gsc_content_decayGSC content decay.seoagent_gsc_cannibalizationGSC keyword cannibalization.seoagent_gsc_action_planGSC prioritized action plan.seoagent_ga4_propertiesGA4 authorized property.seoagent_ga4_reportGA4 report data.seoagent_ga4_traffic_summaryGA4 traffic summary.seoagent_ga4_landing_page_opportunitiesGA4 landing page opportunities.seoagent_ga4_channel_insightsGA4 channel quality diagnosis.seoagent_ga4_action_planGA4 priority action plan.seoagent_estimateEstimate before actual query.MCP calls still use the same SEO Agent API Key, complying with the key's interface permissions, quota, validity, and account balance rules. If not passed location、language then the MCP tool defaults to United States / English query.
Available APIs
High-frequency SEO data capabilities are opened first, with further expansion possible based on customer usage.
| API | Purpose | Required parameters | Suitable scenario |
|---|---|---|---|
POST /api/dev/keyword-research |
Keyword Research | keyword or keywords |
Query seed keyword search volume, competition, related words, and priority; batch keywords are deduplicated first. |
POST /api/dev/keyword-intelligence |
In-depth Keyword Research | keyword |
Fill in KD, CPC, trends, search intent, question keywords, and commercial value, and return keyword groups and suggested page types. |
POST /api/dev/domain-keyword-opportunities |
Domain-specific keyword opportunities | domain + keyword |
Combining the target domain's existing organic rankings and seed keyword expansion data, output opportunity score, current ranking, matching pages, difficulty fit, and page action suggestions. |
POST /api/dev/estimate |
Cost Estimation | endpoint + params |
Estimate the maximum cost before the actual query; no query is executed and no fee is charged. |
POST /api/dev/domain-keywords |
Domain Keywords | domain |
View the website's current organic ranking keywords. |
POST /api/dev/competitor-gap |
Competitor gap | domains or domain + competitor |
Find keyword opportunities where competitors have rankings but you are missing. |
POST /api/dev/competitor-keyword-strategy |
Competitor Keyword Strategy | keyword |
Enter a seed keyword to return top-ranking peers, competitor keywords, keyword type, search intent, page type, and strategic judgment. |
POST /api/dev/serp-rank-query |
Ranking Query | keyword + domain |
Query the target website's ranking for the specified keyword. |
POST /api/dev/geo-visibility |
GEO Visibility | topic、keyword or domain |
Query Google AI Overview or ChatGPT current mentions, target metrics, high-frequency source domains, and pages by brand, domain, or topic. |
POST /api/dev/geo-visibility-history | AI Visibility Historical Trends | topic、keyword or domain | View historical monthly mentions and AI search volume, with support for specified platforms and date ranges. |
POST /api/dev/geo-visibility-delta | AI visibility delta | Analysis object + optional date and groupRange | View the magnitude of changes in mentions and AI search volume by week, month, or year. |
POST /api/dev/geo-visibility-new-lost | New and lost mentions | Analysis object + optional date and groupRange | Separately monitor AI mentions gained and lost during the period. |
POST /api/dev/geo-visibility-comparison | Multi-target visibility comparison | targets(2 to 10) | Unify market, language, and platform to calculate the relative visibility share of multiple objects. |
POST /api/dev/geo-brand-landscape | Brand and category landscape | topic、keyword or domain | Query high-frequency brands and brand categories in AI answers; Lite mode supported. |
POST /api/dev/geo-deep-audit |
GEO Deep Audit | url or domain |
Generate page representation review clues; check public AI crawler rules, llms.txt, and the page's actual JSON-LD types. Internal scoring is only for prioritizing reviews; an optional PDF report can be returned. |
POST /api/dev/site-audit |
On-site audit | url or domain |
Use SEO Agent's built-in crawler to check page status, title, description, H1, canonical, internal and external links, image alt, content relevance, keyword coverage, duplicate content clustering, response speed, noindex, and structured data; optionally enable JS rendering. |
POST /api/dev/gsc-sites |
GSC authorized sites | None | Query the list of GSC sites connected to the account associated with the current API Key; before use, connect GSC on the profile page first. |
POST /api/dev/gsc-search-analytics |
GSC Search Performance | Optional siteUrl、startDate、endDate |
Read queries, pages, clicks, impressions, CTR, and average ranking for the authorized site; if not passed siteUrl use the default site selected on the profile page. |
POST /api/dev/gsc-keyword-opportunities |
GSC keyword opportunities | Optional siteUrl、minImpressions |
Identify Quick Win keyword opportunities, such as high impressions with low clicks and rankings 8-20, based on real GSC search performance. |
POST /api/dev/gsc-page-opportunities |
GSC page opportunities | Optional siteUrl、startDate、endDate |
Aggregate GSC query performance per page to output page opportunities requiring title, content coverage, and internal link optimization. |
POST /api/dev/gsc-performance-summary |
GSC performance summary | Optional siteUrl、startDate、endDate |
Compare the current period with the previous equal-length period, and output changes in clicks, impressions, CTR, average ranking, as well as sources of growth and decline. |
POST /api/dev/gsc-content-decay |
GSC content decline | Optional minPreviousClicks、dropRateThreshold |
Identify pages and queries with significant declines in clicks or rankings, for content refresh, indexation checks, and title review. |
POST /api/dev/gsc-cannibalization |
GSC keyword cannibalization | Optional minQueryImpressions、minCompetingPages |
Detect situations where the same query is served by multiple pages, helping to determine primary page, merging, canonical, or content differentiation strategies. |
POST /api/dev/gsc-action-plan |
GSC priority action plan | Optional siteUrl、limit |
Synthesize keyword opportunities, page opportunities, content decay, and keyword cannibalization, and output a P0/P1/P2 execution checklist and review metrics. |
POST /api/dev/ga4-properties |
GA4 authorized property | None | Query the list of GA4 properties connected to the account corresponding to the current API Key; before using, you need to connect GA4 on the profile page first. |
POST /api/dev/ga4-report |
GA4 report data | Optional propertyId、dimensions、metrics |
Read standard report data from authorized properties, which can be broken down by landing page, channel, country, device, and date. |
POST /api/dev/ga4-traffic-summary |
GA4 traffic summary | Optional propertyId、startDate、endDate |
Summarize sessions, users, views, key events, channels, devices, and country performance to assess traffic quality. |
POST /api/dev/ga4-landing-page-opportunities |
GA4 landing page opportunities | Optional minSessions、rowLimit、limit |
Identify landing pages that have visits but poor engagement, high bounce rates, or insufficient key events, and output page optimization priorities. |
POST /api/dev/ga4-channel-insights |
GA4 channel quality diagnosis | Optional minSessions、limit |
Break down sessions, engagement, bounces, and key events by channel to determine which sources need to be re-evaluated for landing experience quality. |
POST /api/dev/ga4-action-plan |
GA4 priority action plan | Optional propertyId、minSessions、limit |
Combine GA4 traffic summary, landing page opportunities, and channel diagnostics, and output a P0/P1/P2 execution checklist and review metrics. |
POST /api/dev/site-audit-async |
Site Audit (Async) | url or domain, optional callbackUrl |
Asynchronously submit a site audit task and immediately return the task ID. Supports via callbackUrl Receive completion notification, or via GET /api/dev/site-audit-async/{taskId} Query task status and results. |
GET /api/dev/site-audit-async/{taskId} |
Query async task status | Path parameters: taskId |
Query the current status (pending / processing / completed / failed) and result data of the async audit task. |
POST /api/dev/balance |
Account Balance | None | Query the account balance, available credit, and plan information associated with the current API Key. |
POST /api/dev/usage-records |
Consumption record details | None | Query the historical usage records of API calls, including endpoint type, call time, charged amount, and call status. |
Common optional parameters: location、language、limit、dryRun. For batch keywords, you can pass keywords, for similar word selection you can pass dedupeMode: "all" or dedupeMode: "smart"; for domain-specific keyword opportunities, you can pass domainKeywordLimit Controls the domain ranking keyword sample used for matching. For competitor keyword strategy, you can pass competitorLimit and keywordsPerCompetitor, with standard edition limits of 5 and 10 respectively; for site audit, you can pass limit、maxDepth、targetKeywords、duplicateSimilarityThreshold、renderJavascript、renderWaitMs、respectRobots and includeSubdomains, no country or language parameters needed. The GSC API uses authorized sites and date ranges; you can pass siteUrl、startDate、endDate、dimensions、rowLimit、searchType; for deep diagnosis, you can pass minPreviousClicks、dropRateThreshold、minQueryImpressions and minCompetingPages. The GA4 API uses authorized properties; you can pass propertyId、startDate、endDate、dimensions、metrics、rowLimit and minSessions.
Default market reminder: if the request does not pass location and language, API/MCP defaults to United States / English query; when querying other countries or languages, please pass it explicitly.
Competitor keyword strategy analysis output content
This API returns up to 5 competitors and 10 high-search-volume keywords per competitor, organizing the keyword strategies of top-ranking peers into a standardized structure for further analysis.
| Return fields | Content | Purpose |
|---|---|---|
competitorCount / keywordCount |
Actual number of competitors and total keywords returned. | Used to determine the sample size of this data; when below the limit, the actual count is shown. |
competitors |
List of top-ranking competitor websites, including rank, domain, page title, and URL. | Used to identify which competitors dominate the top Google results for the current keyword. |
keywords |
Competitor keyword details, including competitor domain, keyword, keyword rank, search volume, estimated traffic, ranking URL, keyword type, search intent, suggested page type, and opportunity assessment. | Used to analyze which keywords and page types competitors use to drive traffic, and to plan your own pages. |
strategySummary |
SEO Agent's summary of keyword structure and business opportunities. | Used to quickly determine whether to prioritize category pages, product pages, scenario pages, tutorial pages, review pages, or comparison pages. |
In the field, competitorLimit and keywordsPerCompetitor it is the query limit, not a guarantee of full return. The returned results are organized into SEO Agent's unified fields, making it easy for Codex, Python, or internal systems to continue processing.
Quick integration
Follow these 4 steps to integrate: get your Key first, then decide whether to use MCP or API, estimate costs before querying, and finally read the standardized fields.
data read results, from billing read billing and cache status.
Minimal request example
All endpoints use POST requests and include your own API Key in the Header.
curl -X POST https://www.seoagent.vip/api/dev/domain-keyword-opportunities \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"domain": "example.com",
"keyword": "custom hoodie manufacturer",
"location": "United States",
"language": "English",
"limit": 10
}'
Focus on these items in the response
queryThe actual query parameters for this request, for easy recording and review.dataStandardized results, e.g., competitors, keywords, pages.billingCharge for this request, estimated cost, and cache hit status.apiVersionCurrent API response version.{
"scope": "domain-keyword-opportunities",
"query": { "domain": "example.com", "keyword": "custom hoodie manufacturer" },
"data": {
"keywords": [
{ "keyword": "custom hoodie manufacturer", "priority": "P0", "recommendation": "Optimize existing page" }
],
"groups": []
},
"billing": {
"amountCents": 386,
"cached": false
}
}
Cache mechanism and cost-saving strategies
Requests with identical parameters automatically hit the cache. Repeated calls during the cache period are charged according to cache reuse rules. Making good use of the cache can significantly reduce batch query costs.
Cache rules
Cache validity periodDefault 7 days (604,800 seconds), counted from the first successful call.Cache key compositionAPI identifier + request parameters (serialized after sorting object keys).Parameters excluded from cachingkeywordDeduplication Deduplication mode does not affect cache hits.Cacheable endpointsAll cacheable SEO data endpoints (keyword-research, keyword-intelligence, domain-keyword-opportunities, domain-keywords, competitor-gap, competitor-keyword-strategy, serp-rank-query, geo-visibility, geo-deep-audit, site-audit).Cache hit chargesBilled according to cache reuse rules. In the response billing.cached is true, the specific amount is based on billing.amountCents as the standard.Cache fields in the response
Each endpoint response's billing fields contain cache status, which can be used to determine whether it is a cache hit and the remaining validity period.
{
"billing": {
"cached": true,
"amountCents": 18,
"cacheExpiresAt": "2026-07-11T10:30:00.000Z",
"cacheTtlSeconds": 518400
}
}
cachedWhether the cache is hit.cacheExpiresAtCache expiration time (ISO 8601 format).cacheTtlSecondsThe current remaining valid seconds of the cache (when hit), or the default cache validity period (when not hit).Money-saving strategy: use estimate first, then batch queries
Before batch queries, first use /api/dev/estimate to check whether each request is already in the cache, and only make formal calls for requests that are not cache hits.
// Step 1: Batch estimate, filter out uncached requests
POST /api/dev/estimate
{ "endpoint": "keyword-research", "params": { "keyword": "seo tools" } }
// If cacheHit = false, then make the formal call
POST /api/dev/keyword-research
{ "keyword": "seo tools" }
Cache fields in the estimate response
{
"cacheHit": false,
"cacheTtlSeconds": 604800,
"estimatedMaxAmountCents": 120
}
cacheHitWhether this parameter combination is already in the cache.cacheExpiresAtIf cached, returns the cache expiration time.cacheRemainingSecondsIf cached, returns the remaining valid seconds.estimatedMaxAmountCentsEstimate the maximum fee; the actual charge is subject to the billing returned by the formal call.Note: Repeating audits or queries for the same URL/keyword within the cache period will be billed according to the cache reuse rules, which is usually cheaper than re-querying. It is recommended to use estimate to fully check cache hit status before starting batch tasks, and plan the call order to maximize the cache window.
Queries for multiple countries/markets
Each API request corresponds to only one country and one language; if you need to query multiple countries, split them into multiple requests by country and language.
Correct approach: make separate requests for each market.
POST /api/dev/competitor-keyword-strategy
{
"keyword": "custom hoodie manufacturer",
"location": "United States",
"language": "English"
}
POST /api/dev/competitor-keyword-strategy
{
"keyword": "custom hoodie manufacturer",
"location": "Canada",
"language": "English"
}
POST /api/dev/competitor-keyword-strategy
{
"keyword": "custom hoodie manufacturer",
"location": "Australia",
"language": "English"
}
Python batch request example
import requests
api_key = "YOUR_API_KEY"
url = "https://www.seoagent.vip/api/dev/competitor-keyword-strategy"
markets = [
{"location": "United States", "language": "English"},
{"location": "Canada", "language": "English"},
{"location": "Australia", "language": "English"},
]
for market in markets:
payload = {
"keyword": "custom hoodie manufacturer",
**market
}
response = requests.post(
url,
headers={"Authorization": f"Bearer {api_key}"},
json=payload
)
print(market["location"], response.json())
Do not put multiple countries in the same location field, for example United States, Canada, Australia. Multiple countries will be billed as separate API queries; if the same country, language, and keyword hit the cache, the corresponding request is billed according to system rules.
Cost estimation and keyword deduplication
External tools can estimate the cost first before deciding whether to run the actual query; batch keywords automatically handle exact duplicates, while similar keywords can be selected by the customer.
Cost estimation example
curl -X POST https://www.seoagent.vip/api/dev/estimate -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"endpoint":"keyword-research","params":{"keywords":["Wooden Puzzle","wooden puzzle","wooden puzzles"],"location":"United States","language":"English","limit":10}}'
Estimated response
{
"endpoint": "keyword-research",
"cacheHit": false,
"estimatedMaxAmountCents": 80,
"estimatedMaxAmountYuan": "0.80",
"billableRequestCount": 2,
"keywordDeduplication": {
"exactDuplicateCount": 1,
"choices": [
{ "id": "all", "label": "Query all" },
{ "id": "smart", "label": "Smart deduplication" }
]
},
"note": "This is the estimated maximum cost; the actual cost may be lower due to cache hits."
}
The integrator can keywordDeduplication.choices render them as two buttons; to select "Query all", pass dedupeMode: "all", to select "Smart deduplication", pass dedupeMode: "smart".
Usage rules and common errors
scope_not_allowed Indicates that the current Key does not have access to this API endpoint.
api_key_spend_limit_exceeded Indicates that the remaining quota for this Key is insufficient.