search_rankwise_content
Search Rankwise guides
Search Rankwise's public library: guides, glossary terms, comparisons, free SEO and AI visibility tools, the AI crawler directory (GPTBot, ClaudeBot and others) and the AI engine pages. Returns matching titles with canonical URLs.
輸入參數limitquery必填
list_rankwise_sitemaps
List Rankwise sitemaps
List the sitemap URLs exposed by Rankwise so agents can enumerate indexable content.
無需輸入參數。
check_ai_crawler_access
Check AI crawler access
Check whether AI crawlers (GPTBot, ClaudeBot, PerplexityBot, Google-Extended and others) are allowed or blocked by a website's robots.txt. Returns each crawler's status.
輸入參數url必填
score_ai_visibility
Score AI visibility readiness
Score how ready a website's homepage is to be found and cited by AI search engines (crawler access, structured data, content signals). Returns a score, issues and quick wins. This is an on-page readiness check, not a measurement of real AI citations. Called without signing in, the result also carries a claim link: give it to the person who runs the site, and one sign-in opens a Rankwise workspace with that domain already added, ready once they start the 3-day free trial. A claim link works once and expires after 72 hours.
輸入參數domain必填
check_citation_readiness
Check page citation readiness
Check whether a single page is easy for AI engines to quote and cite: clear answers, headings, metadata, authorship and freshness signals. Returns findings for that page.
輸入參數url必填
get_free_ai_audit_link
Get free AI audit link
Get the link to Rankwise's free AI visibility audit for a domain. The audit checks AI crawler access and technical readiness, and runs live Perplexity queries to see whether the brand is cited. The user opens the link to run it; this tool does not run the audit.
輸入參數domain必填
get_workspace
Get workspace
Show the Rankwise workspace this connection acts in: its name, kind (personal or agency client), your role in it, and the permissions this connection has. Every other account tool works inside this one workspace.
無需輸入參數。
get_plan_and_credits
Get plan and credits
Show the workspace's billing plan, its credit balance, what one approved brief costs in credits, and the plan limits (domains, questions, AI engines, monthly AI checks). Use it before a tool that spends credits or a plan allowance. A plan of 'free_trial' means the 3-day free trial: trial limits apply, and articles written in it carry a watermark and publish once the plan starts. A plan of 'paused' means the workspace has no active plan: it never started one, its trial or subscription was canceled, its billing is paused, or it took the 14-day money-back guarantee. Nothing is deleted, but checks and writing stay stopped until the workspace has an active plan again. Every plan has a 14-day money-back guarantee from the first payment, once per customer, refunded from the Billing page. pricing_url describes the plans.
無需輸入參數。
List the site this connection reaches: its id (the workspace id), name, tracked domains, and whether automatic articles are on, how many a week, and whether they are paused. A connection reaches one site; connect again (or add a CLI profile) for another.
無需輸入參數。
pause_site
Pause automatic articles
Pause automatic articles for the site. While paused nothing runs on its own: no planner fill, no drafting, no publishing, no credits used. Manual actions still work. Resume with resume_site.
輸入參數site_id
resume_site
Resume automatic articles
Resume automatic articles for the site after a pause. Cards left on days that passed move to the next free publishing days. Resuming is free.
輸入參數site_id
create_checkout_link
Create a checkout link
Create a Stripe Checkout link for a self-serve Rankwise plan (starter, growth or scale) for this workspace's account, and give it to the person. Nothing is charged by this call: the person opens the link and pays in their browser. If the account already has an active plan, the link opens the billing page to confirm the plan change instead. Agency plans are set up with the Rankwise team. Send a unique idempotency_key and reuse it on a retry.
輸入參數plan必填idempotency_key必填
list_domains
List tracked domains
List the domains this workspace tracks for AI visibility, with each domain's id, composite visibility score (0 to 100, null when not scored yet), number of tracked questions, how many questions AI engines mention the brand for, and the last crawl time. Use the id with the other domain tools.
無需輸入參數。
Start tracking a domain's AI visibility in this workspace. Rankwise seeds the homepage and crawls and scores it in the background. Fails when the plan's domain limit is reached. Free: it uses no credits.
輸入參數domain必填brand_domains
recrawl_domain
Re-crawl a domain
Queue a fresh crawl and re-score of a tracked domain's pages. It runs in the background and takes a few minutes; read get_scorecard afterwards. Free: it uses no credits.
輸入參數domain_id必填
remove_domain
Remove a domain
Stop tracking a domain and permanently delete its questions, AI answers, scores and history. This cannot be undone.
輸入參數domain_id必填
list_questions
List tracked questions
List the questions tracked for a domain (the prompts Rankwise asks AI engines), each with its id, market locale, and the latest check result: cited, not_cited or error, the citation position and when it ran.
輸入參數domain_id必填
add_question
Add a question
Track a new question for a domain, e.g. "best invoicing software for freelancers". Scheduled checks then ask the plan's AI engines whether they cite the brand. Fails at the plan's question limit. Free: it uses no credits.
輸入參數localequestion必填domain_id必填
remove_question
Remove a question
Stop tracking a question and delete its check history. This cannot be undone.
輸入參數question_id必填
get_scorecard
Get AI visibility scorecard
Read a domain's AI Visibility Scorecard: the composite score (0 to 100, null when nothing is measured yet) and the latest score, confidence and recommendations for each dimension.
輸入參數domain_id必填
list_citations
List AI citations
For each tracked question and AI engine, show the latest real measurement: whether the engine cited the brand, at which position, which URLs it cited, and when. An engine that failed to answer is skipped rather than counted as not cited.
輸入參數limitdomain_id必填
get_share_of_voice
Get AI share of voice
Read a domain's latest AI Share of Voice snapshot: the brand's share of AI answers, its own citations and mentions, the competitor leaderboard, and up to 12 earlier snapshots. Null when it was never measured.
輸入參數domain_id必填
list_visibility_events
List visibility events
List recent AI visibility events in the workspace, newest first: citations won and lost, fixes proposed, goals reached. Optionally only since a date or for one domain.
輸入參數limitsincedomain_id
run_citation_check
Run an AI citation check
Ask the plan's AI engines one tracked question now and record whether each cites the brand. Engines checked in the last few hours are served from that result at no cost. Uses the workspace's monthly on-demand check allowance. Send a unique idempotency_key, and the same one on a retry.
輸入參數question_id必填idempotency_key必填
refresh_share_of_voice
Refresh AI share of voice
Capture a fresh AI Share of Voice snapshot for a domain from DataForSEO LLM Mentions. A snapshot from the last 12 hours is returned instead of buying a new one, because the index lags by days. Send a unique idempotency_key, and the same one on a retry.
輸入參數domain_id必填idempotency_key必填
list_opportunities
List content opportunities
List the workspace's ranked content opportunities: topics where AI engines answer questions the brand is not cited for, scored by demand, citation gap and feasibility. Dismissed topics are left out. Each item says whether a brief or article already covers it.
輸入參數limit
refresh_opportunities
Refresh content opportunities
Recompute the workspace's opportunity queue from its tracked questions and AI citation data, and look for new topics. Uses paid search and AI data, so it runs at most once every 10 minutes per workspace. Send a unique idempotency_key; retry with the same key.
輸入參數idempotency_key必填
dismiss_opportunity
Dismiss a content opportunity
Remove one topic from the workspace's opportunity queue. It can be restored in the Rankwise app (Demand page). Nothing is deleted.
輸入參數opportunity_id必填
List the workspace's content briefs, newest first: drafts waiting for approval (including ones Rankwise suggested), approved pieces being written, and finished ones. Filter by status. An expert sees only the briefs assigned to them.
輸入參數limitstatus
Read one brief in full: title, topic, intent, target questions, outline, research notes, suggested sources, status, and the draft article once it exists.
輸入參數brief_id必填
create_brief
Create a brief
Create a draft brief for an article. Nothing is written or charged until the brief is approved with approve_brief. If tracked_domain_id is left out, the workspace's first tracked domain grounds the brief.
輸入參數tonetitle必填topicintentaudiencelanguagetarget_queriestracked_domain_id
update_brief
Update a brief
Edit a draft brief before it is approved: title, topic, intent, target questions or outline. An approved brief cannot be edited; edit its draft article in the app instead.
輸入參數titletopicintentoutlinebrief_id必填target_queries
archive_brief
Archive a brief
Remove a draft brief that was never approved. Approved briefs cannot be archived because their credits were spent. The brief can be restored in the app, and its topic goes back to the opportunity queue.
輸入參數notereasonbrief_id必填
approve_brief
Approve a brief
Approve a draft brief. This debits the workspace's credits (see get_plan_and_credits for the cost) and starts writing the AI draft article, which then waits for review; nothing is published. Re-approving a draft whose generation failed is free. Send a unique idempotency_key and reuse it on retry.
輸入參數brief_id必填idempotency_key必填
list_articles
List articles
List the articles in this workspace, newest first: title, status (generating, ready, published, failed), publish status and published URL. Experts see only the drafts assigned to them. Filter by status or title words.
輸入參數pagequerystatuspage_size
Read one article in this workspace: its metadata, status, meta description, the first 4,000 characters of its text (or the full HTML with include_html), the sources it cites, and the Article and FAQ structured data (JSON-LD) that ships with it. Use list_articles to find the id.
輸入參數article_id必填include_html
generate_article
Generate article
Write a new AI article for a keyword. It uses the same research-and-cite writer as Autopilot: real sources, links only to pages that exist, a closing call to action, and Article and FAQ schema. This spends workspace credits (1 for short, 2 for medium, 3 for long, 4 for comprehensive; check get_plan_and_credits first). The article is generated in the background and is NOT published: call publish_article for that. Retries with the same idempotency_key never spend twice.
輸入參數tonelengthkeyword必填languagearticle_typeintegration_ididempotency_key必填
publish_article
Publish article
Publish one article to the workspace's connected CMS (WordPress, WordPress.com, Shopify, Webflow, Wix, Ghost, Notion, Framer or a self-hosted site). This makes it live on the customer's website. A brief draft must be approved by its expert first. If the workspace has several CMS connections and no default destination, name one with integration_id. Pass publish_at (an ISO date-time) to schedule it, or "next_slot" for the workspace's next publish time. To change an article that is already published, do not publish it again (on some sites that adds a second post): edit it with replace_article, then call update_live_post.
輸入參數article_id必填publish_atintegration_ididempotency_key必填
update_live_post
Update live post
Send the saved version of a published article over its live post, on the site it is already on, so the post changes at its URL and no second post is added. Edit the article first with replace_article. update_live_post updates the live post in place on WordPress (Rankwise plugin), Next.js (@rankwise/next), Rails (rankwise-rails), the webhook integration and Shopify. On the Rankwise-hosted blog and Framer a saved edit is already live (Framer at its next sync), so there is nothing to push. Webflow, Wix, Notion, Ghost and WordPress.com cannot update a live post from Rankwise: change the post in that CMS by hand. On those sites this call is refused before anything is sent. It runs now and cannot be scheduled. A brief draft must still be approved by its expert. Retries with the same idempotency_key never send twice.
輸入參數article_id必填idempotency_key必填
replace_article
Replace an article
Replace an article's title, meta description, slug or full HTML body. Send only the fields to change. The slug must be unique in the workspace, and a published article keeps its slug. Open tracked changes are dropped when the body changes. This saves the article in Rankwise; live_update and next_step in the result say how a published article's live post takes the edit. update_live_post updates the live post in place on WordPress (Rankwise plugin), Next.js (@rankwise/next), Rails (rankwise-rails), the webhook integration and Shopify. On the Rankwise-hosted blog and Framer a saved edit is already live (Framer at its next sync), so there is nothing to push. Webflow, Wix, Notion, Ghost and WordPress.com cannot update a live post from Rankwise: change the post in that CMS by hand. Free.
輸入參數htmlslugtitlearticle_id必填meta_description
bulk_replace_articles
Replace several articles
Replace up to 50 articles in one call, with the same rules as replace_article. Each article succeeds or fails on its own; the result lists both.
輸入參數articles必填
get_autopilot
Get autopilot settings
Show the workspace's content autopilot: its mode (off, draft_only, requires_approval, full_auto), weekly article quota, whether it is paused, the plan's quota ceiling, suggestions waiting for a decision, and the upcoming approval days.
無需輸入參數。
set_autopilot
Change autopilot settings
Change the workspace's content autopilot. mode: off, draft_only (only suggests briefs, spends nothing) or requires_approval (approves up to the weekly quota of suggested briefs, which spends credits, and holds every draft for review). weekly_quota is capped by the plan. paused pauses or resumes. Auto-publishing (full_auto) cannot be switched on here; do that in the Rankwise app.
輸入參數modepausedweekly_quota
get_planner
Get the Content Planner
Read the Content Planner: one card per publishing day with its title, keyword, article type, state (planned, writing, review, published, failed), and search volume and difficulty when measured. Defaults to the window the planner page shows; pass from and to (YYYY-MM-DD, at most 120 days apart) for another. Cards waiting for a day come back under unscheduled.
輸入參數tofrom
move_planner_card
Move a planner card
Move a card that is not written yet to another publishing day. If another unwritten card holds that day, the two swap. A day held by an article that is being written or is published is refused. Free.
輸入參數day必填card_id必填
list_keywords
List keywords
List the keywords in the Content Planner, one per card, with the article title, its day, state, and search volume and difficulty when measured. Filter by state. To export them as CSV, call GET /api/v1/keywords?format=csv.
輸入參數state
add_keywords
Add keywords to the planner
Add up to 50 keywords to the Content Planner. Each becomes a card. With a day it takes that day (an unwritten card there moves to the next free day); without one it takes the next free publishing day. Keywords already planned are skipped, so a retry never adds twice. Free: articles are drafted when their day comes.
輸入參數keywords必填
get_search_console_summary
Get Search Console summary
Read the site's Google Search Console numbers for the last 28 days: total clicks and impressions, and the best articles by clicks. connected is false until Search Console is connected and has synced once.
無需輸入參數。
list_fixes
List proposed fixes
List the on-page fixes Rankwise proposes for a domain (structured data, head tags, robots rules and similar), each with the page pattern it targets, the dimension it improves, why, and its status. Rankwise does not change the site; the user or their developer applies a fix.
輸入參數domain_id必填
preview_fixes
Preview proposed fixes
Show the exact change each proposed fix would make to the domain's pages, as a before and after diff. A dry run: it reads the live pages and changes nothing.
輸入參數domain_id必填