auth_whoami | auth whoami | read | core | Verify auth and return the current user and organization details. |
auth_status | auth status | local | core | Show the resolved profile, auth source and base-url configuration (the key itself is never shown). |
usage_stats | usage stats | read | core | Return current usage and quota metrics for articles, backlinks, free tools, and product slots. |
subscription_status | subscription status | read | core | Return the current subscription, plan, trial, quota, and add-on status. |
billing_portal_url โ
| billing portal-url | read | billing | Return a Stripe customer-portal link for the human to open in a browser. |
billing_purchase_products_quote โ
| billing purchase-products quote | read | billing | Request pricing for additional product slots without authorizing the charge. |
billing_purchase_products_buy | billing purchase-products buy | money | billing | Buy additional product slots at the quoted recurring total. |
keywords_list | keywords list | read | keywords | List keywords for a product with optional filters and pagination. |
keywords_get | keywords get | read | keywords | Get one keyword by id. |
keywords_export | keywords export | read | keywords | Export the keyword plan for a product. |
keywords_generation_status | keywords generation-status | read | keywords | Show keyword generation status and scheduler slot capacity for a product. |
keywords_add | keywords add | write | keywords | Add a keyword to a product from a JSON body. |
keywords_update | keywords update | write | keywords | Update a keyword (instructions, schedule, quality questions) from a JSON body. |
keywords_suggest | keywords suggest | read | keywords | Suggest keywords for a product from a seed keyword or a theme. |
keywords_generate | keywords generate | write | keywords | Generate keywords for a product from competitors and/or target audiences. |
keywords_bulk_process | keywords bulk-process | read | keywords | Bulk-process a list of keywords for a product from a JSON body. |
keywords_bulk_reschedule | keywords bulk-reschedule | write | keywords | Reschedule several keywords from a JSON body. |
keywords_delete | keywords delete | destructive | keywords | Delete one keyword. |
keywords_bulk_delete | keywords bulk-delete | destructive | keywords | Delete several keywords from a JSON body of ids. |
articles_list | articles list | read | articles | List articles with optional filters, sorting and pagination. |
articles_create | articles create | write | articles | Create an article from your own content and optionally publish it to the connected CMS. |
articles_get | articles get | read | articles | Get article metadata by id. |
articles_get_content | articles get-content | read | articles | Get the article body as markdown or HTML. |
articles_update | articles update | write | articles | Update article metadata from a JSON body. |
articles_update_content | articles update-content | write | articles | Replace the article body from a JSON body. |
articles_replace | articles replace | write | articles | Find and replace text inside one article. |
articles_bulk_replace | articles bulk-replace | write | articles | Find and replace text across several articles from a JSON body. |
articles_upload_image | articles upload-image | write | articles | Upload an image for an article or a keyword. |
articles_upload_featured_image | articles upload-featured-image | write | articles | Upload the featured image of an article. |
articles_publish | articles publish | write | articles | Publish an article to the product's connected CMS for the first time. |
articles_sync | articles sync | write | articles | Push the edits of a published article to the post already in the connected CMS. |
articles_retry_publish | articles retry-publish | write | articles | Retry publishing an article to its integration. |
articles_delete | articles delete | destructive | articles | Delete an article. |
articles_precreate | articles precreate | write | articles | Pre-create the article for an eligible future scheduled keyword. |
articles_generate | articles generate | write | articles | Generate the article for a keyword scheduled for today. |
improvements_settings_get | improvements settings get | read | improvements | Get the article improvement settings of a product. |
improvements_settings_update | improvements settings update | write | improvements | Update the article improvement settings of a product from a JSON body. |
improvements_analyze | improvements analyze | write | improvements | Run improvement opportunity discovery for a product (multi-minute). |
improvements_candidates_list | improvements candidates list | read | improvements | List improvement candidates for a product. |
improvements_candidates_brief | improvements candidates brief | write | improvements | Generate the improvement brief for a candidate (multi-minute). |
improvements_candidates_edit_brief | improvements candidates edit-brief | write | improvements | Edit the improvement brief of a candidate from a JSON body. |
improvements_candidates_schedule | improvements candidates schedule | write | improvements | Schedule an improvement task for a candidate. |
improvements_tasks_list | improvements tasks list | read | improvements | List scheduled improvement tasks for a product. |
improvements_tasks_reschedule | improvements tasks reschedule | write | improvements | Reschedule an improvement task. |
improvements_tasks_cancel | improvements tasks cancel | destructive | improvements | Cancel an improvement task. |
improvements_tasks_edit_brief | improvements tasks edit-brief | write | improvements | Edit the brief of an improvement task from a JSON body. |
improvements_tasks_execute | improvements tasks execute | write | improvements | Execute an improvement task now (multi-minute). |
improvements_executions_list | improvements executions list | read | improvements | List improvement executions for a product. |
improvements_executions_get | improvements executions get | read | improvements | Get one improvement execution with its proposed changes. |
improvements_executions_decisions | improvements executions decisions | write | improvements | Record review decisions for an execution from a JSON body. |
improvements_executions_push | improvements executions push | write | improvements | Push an execution to the CMS, optionally with decisions in a JSON body. |
products_list | products list | read | core | List products with optional status filter and cursor pagination. |
products_get | products get | read | core | Get one product. |
products_create | products create | write | core | Create a product from a JSON body. The server queues an initial keyword plan. |
products_update | products update | write | core | Update a product from a JSON body. |
products_pause | products pause | destructive | core | Pause a product and free its slot. |
products_resume | products resume | write | core | Resume a paused product. |
products_integrations_providers | products integrations providers | read | integrations | List known integration providers with their auth method and required fields. |
products_integrations_prepare | products integrations prepare | write | integrations | Prepare a provider integration for a product (e.g. generate the WordPress plugin token). |
products_integrations_connect | products integrations connect | write | integrations | Start an OAuth connect flow for a provider and return the connect URL. |
products_integrations_poll | products integrations poll | read | integrations | Poll an OAuth connect attempt until the handoff completes. |
products_integrations_notion_databases | products integrations notion databases | read | integrations | List the Notion databases accessible to a connected integration. |
products_integrations_notion_schema | products integrations notion schema | read | integrations | Inspect the schema of one Notion database. |
products_integrations_webflow_sites | products integrations webflow sites | read | integrations | Discover webflow sites with the credentials in the JSON body. |
products_integrations_webflow_collections | products integrations webflow collections | read | integrations | Discover webflow collections with the credentials in the JSON body. |
products_integrations_webflow_fields | products integrations webflow fields | read | integrations | Discover webflow fields with the credentials in the JSON body. |
products_integrations_webflow_items | products integrations webflow items | read | integrations | Discover webflow items with the credentials in the JSON body. |
products_integrations_framer_collections | products integrations framer collections | read | integrations | Discover framer collections with the credentials in the JSON body. |
products_integrations_framer_fields | products integrations framer fields | read | integrations | Discover framer fields with the credentials in the JSON body. |
products_integrations_validate | products integrations validate | read | integrations | Validate provider credentials from a JSON body without saving them. |
products_integrations_list | products integrations list | read | integrations | List the publishing integrations of a product. |
products_integrations_create | products integrations create | write | integrations | Create a publishing integration for a product from a JSON body. |
products_integrations_get | products integrations get | read | integrations | Get one integration of a product. |
products_integrations_update | products integrations update | write | integrations | Update one integration of a product from a JSON body. |
products_integrations_test | products integrations test | write | integrations | Test one integration of a product. |
products_integrations_delete | products integrations delete | destructive | integrations | Delete one integration of a product. |
products_output_settings_get | products output-settings get | read | core | Get the article output settings of a product. |
products_output_settings_update | products output-settings update | write | core | Patch the article output settings of a product from a JSON body. |
products_target_audiences_list | products target-audiences list | read | core | List the target audiences of a product. |
products_target_audiences_replace | products target-audiences replace | destructive | core | Replace the full target-audience list of a product from a JSON body. |
products_competitors_list | products competitors list | read | core | List the competitors of a product. |
products_competitors_replace | products competitors replace | destructive | core | Replace the full competitor list of a product from a JSON body (3-7 entries, server-enforced). |
products_gsc_status | products gsc status | read | gsc | Show the Google Search Console connection status of a product. |
products_gsc_connect | products gsc connect | write | gsc | Start the Google Search Console OAuth handoff and return the connect URL. |
products_gsc_poll | products gsc poll | read | gsc | Poll a Google Search Console connect attempt. |
products_gsc_reconnect | products gsc reconnect | write | gsc | Restart the Google Search Console OAuth handoff for a product. |
products_gsc_disconnect | products gsc disconnect | destructive | gsc | Disconnect Google Search Console from a product. |
products_gsc_accounts | products gsc accounts | read | gsc | List the connected Google accounts of a product. |
products_gsc_properties | products gsc properties | read | gsc | List the Search Console properties of a connected Google account. |
products_gsc_set_property | products gsc set-property | write | gsc | Save the verified Search Console property for a product. |
products_gsc_performance | products gsc performance | read | gsc | Show Search Console performance for the last months. |
products_gsc_search_analytics | products gsc search-analytics | read | gsc | Query Search Console search analytics with dimensions and filters. |
products_gsc_inspect_url | products gsc inspect-url | read | gsc | Inspect the indexing status of one URL. |
products_gsc_cannibalization | products gsc cannibalization | read | gsc | Report keyword cannibalization across the product pages. |
products_linking_sources_get | products linking sources get | read | linking | Get the internal-linking sources of a product. |
products_linking_sources_update | products linking sources update | write | linking | Change the primary or additional internal-linking sources from a JSON body. |
products_linking_detect | products linking detect | write | linking | Detect internal-linking targets for a product (long-running). |
products_linking_target_config_get | products linking target-config get | read | linking | Get the product-wide internal-linking target configuration. |
products_linking_target_config_update | products linking target-config update | write | linking | Replace the product-wide internal-linking target configuration from a JSON body. |
products_linking_targets_list | products linking targets list | read | linking | List the saved internal-linking targets of a product. |
products_linking_targets_add_manual | products linking targets add-manual | write | linking | Add a manual internal-linking target from a JSON body. |
products_linking_targets_upsert | products linking targets upsert | write | linking | Upsert an internal-linking target from a JSON body. |
products_linking_targets_clear_customizations | products linking targets clear-customizations | write | linking | Clear the manual customizations of one internal-linking target. |
products_linking_targets_delete | products linking targets delete | destructive | linking | Delete one internal-linking target. |
products_backlinks_get | products backlinks get | read | backlinks | Get the backlink exchange settings of a product. |
products_backlinks_update | products backlinks update | write | backlinks | Update the backlink exchange settings of a product from a JSON body. |
products_backlinks_credits | products backlinks credits | read | backlinks | Show the backlink credit balance of a product. |
products_backlinks_earned | products backlinks earned | read | backlinks | List earned backlinks with optional article and summary details. |
products_backlinks_unverified | products backlinks unverified | read | backlinks | List backlinks that failed verification. |
products_backlinks_check_removal | products backlinks check-removal | write | backlinks | Check whether an earned backlink was removed. |
products_backlinks_reverify | products backlinks reverify | write | backlinks | Re-run verification for one backlink. |
products_backlinks_subscription โ
| products backlinks subscription | read | backlinks | Show the backlink plan subscription of a product. |
products_backlinks_subscribe_quote โ
| products backlinks subscribe-quote | read | backlinks | Quote a backlink plan subscription for a product. |
products_blog_get | products blog get | read | blog | Show the hosted Outrank Blog of a product with its domain, usage and post counts. |
products_blog_setup | products blog setup | read | blog | Show the suggested name, subdomain and accent color for a new blog on a product. |
products_blog_check_subdomain | products blog check-subdomain | read | blog | Check whether an outrankblog.com subdomain is valid and free. |
products_blog_create | products blog create | write | blog | Create the hosted Outrank Blog of a product; every body field is optional. |
products_blog_update_settings | products blog update-settings | write | blog | Change the blog name, description, language, subdomain, badge, analytics or code injection. |
products_blog_delete | products blog delete | destructive | blog | Delete the blog of a product; its posts become unpublished articles again. |
products_blog_usage | products blog usage | read | blog | Show the plan limits and current usage of the blog. |
products_blog_analytics | products blog analytics | read | blog | Show the built-in traffic analytics of the blog. |
products_blog_starter_posts | products blog starter-posts | read | blog | Show the free AI starter-post allowance and the starter posts being written. |
products_blog_preview | products blog preview | write | blog | Create a short-lived private preview link for the draft design, a draft post or a draft page. |
products_blog_design_get | products blog design get | read | blog | Show the live and draft theme config of the blog. |
products_blog_design_update | products blog design update | write | blog | Save the draft theme config of the blog from a JSON body (the live blog is unchanged). |
products_blog_design_publish | products blog design publish | write | blog | Publish the draft theme to the live blog. |
products_blog_design_discard | products blog design discard | destructive | blog | Discard the draft theme and go back to the live one. |
products_blog_design_patch | products blog design patch | write | blog | Change part of the blog theme (merged into the draft) and optionally publish it. |
products_blog_domain_get | products blog domain get | read | blog | Show the custom domain of the blog and its DNS and verification state. |
products_blog_domain_connect | products blog domain connect | write | blog | Connect or replace the custom domain of the blog from a JSON body. |
products_blog_domain_verify | products blog domain verify | write | blog | Check the DNS of the custom domain and activate it once it is correct. |
products_blog_domain_remove | products blog domain remove | destructive | blog | Remove the custom domain; the blog goes back to its outrankblog.com subdomain. |
products_blog_posts_list | products blog posts list | read | blog | List the posts of the blog with optional status, search and page filters. |
products_blog_posts_create | products blog posts create | write | blog | Write a post on the blog in one call (title, body, SEO fields) as a draft, live or scheduled. |
products_blog_posts_get | products blog posts get | read | blog | Show the settings, status and live URL of one post. |
products_blog_posts_update | products blog posts update | write | blog | Change any field of one post (title, body, SEO, slug, category, cover, status); live posts refresh. |
products_blog_posts_delete | products blog posts delete | destructive | blog | Take one post off the blog and delete it. |
products_blog_posts_get_content | products blog posts get-content | read | blog | Show the title and markdown body of one post. |
products_blog_posts_update_content | products blog posts update-content | write | blog | Replace the title and/or markdown body of one post from a JSON body. |
products_blog_posts_publish | products blog posts publish | write | blog | Publish one post now, or schedule it with --scheduled-for. |
products_blog_posts_unpublish | products blog posts unpublish | write | blog | Take one post off the blog (or cancel its schedule); it becomes a draft. |
products_blog_posts_sync | products blog posts sync | write | blog | Push the latest body of a live post to the blog after editing it. |
products_blog_pages_list | products blog pages list | read | blog | List the pages of the blog. |
products_blog_pages_get | products blog pages get | read | blog | Show one page of the blog. |
products_blog_pages_create | products blog pages create | write | blog | Create a page on the blog from a JSON body. |
products_blog_pages_update | products blog pages update | write | blog | Change one page of the blog from a JSON body. |
products_blog_pages_delete | products blog pages delete | destructive | blog | Delete one page of the blog. |
products_blog_pages_reorder | products blog pages reorder | write | blog | Save the order of the pages from a JSON body of ids and positions. |
products_blog_categories_list | products blog categories list | read | blog | List the categories of the blog. |
products_blog_categories_create | products blog categories create | write | blog | Create a category on the blog from a JSON body. |
products_blog_categories_update | products blog categories update | write | blog | Change one category of the blog from a JSON body. |
products_blog_categories_delete | products blog categories delete | destructive | blog | Delete one category of the blog. |
products_blog_categories_reorder | products blog categories reorder | write | blog | Save the order of the categories from a JSON body of ids and positions. |
products_blog_authors_list | products blog authors list | read | blog | List the authors of the blog. |
products_blog_authors_create | products blog authors create | write | blog | Create an author on the blog from a JSON body. |
products_blog_authors_update | products blog authors update | write | blog | Change one author of the blog from a JSON body. |
products_blog_authors_delete | products blog authors delete | destructive | blog | Delete one author of the blog. |
products_blog_redirects_list | products blog redirects list | read | blog | List the redirects of the blog. |
products_blog_redirects_create | products blog redirects create | write | blog | Create a redirect on the blog from a JSON body. |
products_blog_redirects_delete | products blog redirects delete | destructive | blog | Delete one redirect of the blog. |
products_blog_snippets_list | products blog snippets list | read | blog | List the snippets of the blog. |
products_blog_snippets_create | products blog snippets create | write | blog | Create a snippet on the blog from a JSON body. |
products_blog_snippets_update | products blog snippets update | write | blog | Change one snippet of the blog from a JSON body. |
products_blog_snippets_delete | products blog snippets delete | destructive | blog | Delete one snippet of the blog. |
products_blog_subscribers_list | products blog subscribers list | read | blog | List the newsletter subscribers of the blog. |
products_blog_subscribers_delete | products blog subscribers delete | destructive | blog | Delete one newsletter subscriber of the blog. |
products_blog_webhooks_list | products blog webhooks list | read | blog | List the webhooks of the blog. |
products_blog_webhooks_get | products blog webhooks get | read | blog | Show one webhook of the blog. |
products_blog_webhooks_create | products blog webhooks create | write | blog | Create a webhook on the blog from a JSON body. |
products_blog_webhooks_update | products blog webhooks update | destructive | blog | Change one webhook of the blog from a JSON body. |
products_blog_webhooks_delete | products blog webhooks delete | destructive | blog | Delete one webhook of the blog. |
products_blog_webhooks_test | products blog webhooks test | write | blog | Send a test event to one webhook and report the response status. |
marketplace_seller_add_site โ
| marketplace seller add-site | write | marketplace-seller | Add a site to sell on and get its product id, without creating a regular product. |
marketplace_seller_connect_blog โ
| marketplace seller connect-blog | write | marketplace-seller | Create or reuse the hosted Outrank Blog and connect it for marketplace placements (admin only). |
marketplace_seller_status โ
| marketplace seller status | read | marketplace-seller | Show the seller onboarding and enrollment status of a product. |
marketplace_seller_onboard โ
| marketplace seller onboard | write | marketplace-seller | Run the seller onboarding orchestrator: status, auto-adopt CMS, Stripe Express, eligibility. |
marketplace_seller_eligibility โ
| marketplace seller eligibility | read | marketplace-seller | Read the marketplace seller eligibility of a product. |
marketplace_seller_eligibility_recheck โ
| marketplace seller eligibility recheck | write | marketplace-seller | Recompute the marketplace seller eligibility of a product. |
marketplace_seller_settings_get | marketplace seller settings get | read | marketplace-seller | Get the marketplace seller settings of a product. |
marketplace_seller_settings_update | marketplace seller settings update | write | marketplace-seller | Update the marketplace seller settings of a product from a JSON body (admin only). |
marketplace_seller_integrations_status โ
| marketplace seller integrations status | read | marketplace-seller | Show the marketplace CMS integration status of a product. |
marketplace_seller_integrations_adopt | marketplace seller integrations adopt | write | marketplace-seller | Adopt the existing reusable CMS integration for the marketplace (admin only). |
marketplace_seller_integrations_claim | marketplace seller integrations claim | write | marketplace-seller | Claim a publishing integration for the marketplace (admin only). |
marketplace_seller_integrations_set_activation | marketplace seller integrations set-activation | write | marketplace-seller | Activate or disable a marketplace CMS integration (admin only). |
marketplace_seller_integrations_delete | marketplace seller integrations delete | destructive | marketplace-seller | Remove a marketplace CMS integration (admin only). |
marketplace_seller_stripe_onboard โ
| marketplace seller stripe onboard | write | marketplace-seller | Create the Stripe Express payout account or refresh its onboarding link (admin only). |
marketplace_seller_stripe_manage | marketplace seller stripe manage | read | marketplace-seller | Get the Stripe Express dashboard link (admin only). |
marketplace_seller_stripe_reset | marketplace seller stripe reset | destructive | marketplace-seller | Reset the Stripe Express payout account (admin only). |
marketplace_seller_complete_onboarding โ
| marketplace seller complete-onboarding | write | marketplace-seller | Mark seller onboarding as complete (admin only). |
marketplace_seller_placements_list | marketplace seller placements list | read | marketplace-seller | List marketplace placements hosted by a product. Placement briefs are counterparty data. |
marketplace_seller_placements_approve | marketplace seller placements approve | write | marketplace-seller | Approve a marketplace placement. |
marketplace_seller_placements_decline | marketplace seller placements decline | destructive | marketplace-seller | Decline a marketplace placement. |
marketplace_seller_placements_publish | marketplace seller placements publish | write | marketplace-seller | Publish a marketplace placement. |
marketplace_seller_placements_regenerate | marketplace seller placements regenerate | write | marketplace-seller | Regenerate a marketplace placement. |
marketplace_seller_earnings | marketplace seller earnings | read | marketplace-seller | Show marketplace earnings for a product. |
marketplace_seller_content_history | marketplace seller content-history | read | marketplace-seller | List the marketplace articles a product has hosted. Their titles and keywords are counterparty data. |
marketplace_buyer_status โ
| marketplace buyer status | read | marketplace-buyer | Show the buyer setup status of a product; its guidance drives the sequence. |
marketplace_buyer_billing_status โ
| marketplace buyer billing-status | read | marketplace-buyer | Show the buyer billing status of a product. |
marketplace_buyer_subscription โ
| marketplace buyer subscription | read | marketplace-buyer | Show the buyer backlink subscription of a product. |
marketplace_buyer_subscribe_quote โ
| marketplace buyer subscribe-quote | read | marketplace-buyer | Quote the Enterprise backlink plan that marketplace buying requires. |
marketplace_buyer_checkout โ
| marketplace buyer checkout | money | marketplace-buyer | Start Stripe checkout for the Enterprise backlink plan (admin only; the human completes it). |
marketplace_buyer_change_plan | marketplace buyer change-plan | money | marketplace-buyer | Change, cancel or restore the buyer backlink plan (admin only; cancel actions apply immediately). |
marketplace_buyer_target_pages_list | marketplace buyer target-pages list | read | marketplace-buyer | List the target pages of a buyer product. |
marketplace_buyer_target_pages_add | marketplace buyer target-pages add | write | marketplace-buyer | Add target pages by URL. |
marketplace_buyer_target_pages_discover | marketplace buyer target-pages discover | read | marketplace-buyer | Discover candidate target pages from the sitemap, root URL or integration (long-running). |
marketplace_buyer_target_pages_pause | marketplace buyer target-pages pause | write | marketplace-buyer | Pause a target page. |
marketplace_buyer_target_pages_activate | marketplace buyer target-pages activate | write | marketplace-buyer | Activate a target page. |
marketplace_buyer_target_pages_delete | marketplace buyer target-pages delete | destructive | marketplace-buyer | Delete a target page. |
marketplace_buyer_participation_on | marketplace buyer participation on | write | marketplace-buyer | Turn marketplace buyer participation on (admin only). |
marketplace_buyer_participation_off | marketplace buyer participation off | write | marketplace-buyer | Turn marketplace buyer participation off (admin only). |
marketplace_buyer_placements_list | marketplace buyer placements list | read | marketplace-buyer | List the placements bought by a product. Placement content is counterparty data. |
marketplace_buyer_placements_regenerate | marketplace buyer placements regenerate | write | marketplace-buyer | Regenerate the article of a bought placement. |
marketplace_buyer_placements_revalidate | marketplace buyer placements revalidate | write | marketplace-buyer | Revalidate the live link of a bought placement. |
marketplace_buyer_article_get | marketplace buyer article get | read | marketplace-buyer | Get the article of a bought placement. Its content is counterparty data. |
marketplace_buyer_article_edit | marketplace buyer article edit | write | marketplace-buyer | Edit the article of a bought placement from a JSON body. |
marketplace_buyer_credits_history | marketplace buyer credits history | read | marketplace-buyer | List backlink credit charges and refunds for a product. Seller site and article title are counterparty data. |
marketplace_notifications_list | marketplace notifications list | read | marketplace-seller, marketplace-buyer | List marketplace notifications for a product as seller or buyer. Notification text is counterparty data. |
marketplace_notifications_mark_read | marketplace notifications mark-read | write | marketplace-seller, marketplace-buyer | Mark marketplace notifications as read, all or by id. |
ai_cited_lists_status โ
| ai-cited-lists status | read | ai-cited-lists | Get the AI-Cited Lists state of a product: counters, setup requirements and onboarding. |
ai_cited_lists_overview | ai-cited-lists overview | read | ai-cited-lists | Get the AI-Cited Lists results of a product: won lists, credits used, open offers. |
ai_cited_lists_lists_list | ai-cited-lists lists list | read | ai-cited-lists | List this week's ChatGPT-cited lists and the position we would ask for on each. |
ai_cited_lists_lists_skip | ai-cited-lists lists skip | write | ai-cited-lists | Skip a cited list so no offer goes out for it. |
ai_cited_lists_lists_unskip | ai-cited-lists lists unskip | write | ai-cited-lists | Put a skipped list back in the offer queue. |
ai_cited_lists_outreach | ai-cited-lists outreach | read | ai-cited-lists | List every offer of a product with its stage, the latest owner replies and the sending health. |
ai_cited_lists_offers_get | ai-cited-lists offers get | read | ai-cited-lists | Get one offer: stage, owner contact, email timeline and the entry we asked for. |
ai_cited_lists_offers_withdraw | ai-cited-lists offers withdraw | destructive | ai-cited-lists | Withdraw a draft or sent offer; the owner can no longer claim the spot. |
ai_cited_lists_wins_get | ai-cited-lists wins get | read | ai-cited-lists | Get the proof page of a won list: ChatGPT answers naming the product and the daily checks. |
ai_cited_lists_questions_list | ai-cited-lists questions list | read | ai-cited-lists | List the buyer questions asked to ChatGPT for a product. |
ai_cited_lists_questions_add | ai-cited-lists questions add | write | ai-cited-lists | Add a buyer question to ask ChatGPT. |
ai_cited_lists_questions_edit | ai-cited-lists questions edit | write | ai-cited-lists | Change the wording of a tracked buyer question. |
ai_cited_lists_questions_remove | ai-cited-lists questions remove | destructive | ai-cited-lists | Stop asking a buyer question. |
ai_cited_lists_settings_get | ai-cited-lists settings get | read | ai-cited-lists | Get the AI-Cited Lists settings of a product: sender details, positions, pause, entry. |
ai_cited_lists_settings_update | ai-cited-lists settings update | write | ai-cited-lists | Update the AI-Cited Lists settings of a product from a JSON body. |
ai_cited_lists_mailbox_get | ai-cited-lists mailbox get | read | ai-cited-lists | Get the connected Google mailbox and its four sending checks. |
ai_cited_lists_mailbox_connect | ai-cited-lists mailbox connect | write | ai-cited-lists | Connect the Google mailbox that sends the offers with its address and a Google app password. |
ai_cited_lists_mailbox_domain_check | ai-cited-lists mailbox domain-check | write | ai-cited-lists | Re-run the SPF, DKIM and DMARC check of the mailbox domain. |
ai_cited_lists_mailbox_inbox_test | ai-cited-lists mailbox inbox-test | write | ai-cited-lists | Send the seed-list inbox test from the mailbox (server rate-limited). |
ai_cited_lists_mailbox_filter_test | ai-cited-lists mailbox filter-test | write | ai-cited-lists | Send the reply-filter test email to confirm replies reach Outrank. |
ai_cited_lists_mailbox_dkim_selector | ai-cited-lists mailbox dkim-selector | write | ai-cited-lists | Set the Google Workspace DKIM selector of the mailbox domain, or reset it to the default. |
ai_cited_lists_mailbox_disconnect | ai-cited-lists mailbox disconnect | destructive | ai-cited-lists | Disconnect the Google mailbox and delete its stored app password. |
ai_cited_lists_top_up_consent_get | ai-cited-lists top-up-consent get | read | ai-cited-lists | Read the automatic credit top-up terms and whether they were confirmed. |
ai_cited_lists_top_up_consent_confirm | ai-cited-lists top-up-consent confirm | money | ai-cited-lists | Confirm the automatic credit top-up: authorizes credit-pack purchases on the card on file. |
ai_cited_lists_entry_generate | ai-cited-lists entry generate | write | ai-cited-lists | Write a fresh base entry for the product from its site (multi-minute). |
ai_cited_lists_setup_finish | ai-cited-lists setup finish | write | ai-cited-lists | Mark the dashboard onboarding as finished so the human lands on the tabs. |
ai_cited_lists_citations_summary | ai-cited-lists citations summary | read | ai-cited-lists | Get the AI Citations summary: answers naming the product and the pages ChatGPT cited. |
ai_cited_lists_citations_check | ai-cited-lists citations check | write | ai-cited-lists | Ask ChatGPT the buyer questions now, unless fresh data or a running check exists. |
free_tools_status โ
| free-tools status | read | free-tools | Get the Free Tools Builder state of a product: plan, tool counts and keyword planner slots. |
free_tools_keywords_list | free-tools keywords list | read | free-tools | List the planned free tool keywords of a product with their schedule and tool state. |
free_tools_keywords_add | free-tools keywords add | write | free-tools | Add keywords to the free tools planner; each one gets a tool built on its scheduled day. |
free_tools_keywords_generate | free-tools keywords generate | write | free-tools | Research free tool keywords with AI and add them to the planner (multi-minute). |
free_tools_keywords_delete | free-tools keywords delete | destructive | free-tools | Delete planned free tool keywords that have no tool yet. |
free_tools_create | free-tools create | write | free-tools | Build the free tool of a planned keyword now, or retry a failed first build (multi-minute). |
free_tools_list | free-tools list | read | free-tools | List the free tools of a product with their state, live URL and draft status. |
free_tools_get | free-tools get | read | free-tools | Get one free tool: state, live URL, versions and which builder actions apply. |
free_tools_history | free-tools history | read | free-tools | Read the AI builder conversation of a free tool: requests, replies and suggested next changes. |
free_tools_edit | free-tools edit | write | free-tools | Ask the AI builder to change a free tool; the change lands in a draft (multi-minute). |
free_tools_preview | free-tools preview | read | free-tools | Get the preview link of the current draft of a free tool, waking its sandbox if asked. |
free_tools_publish | free-tools publish | write | free-tools | Publish the draft of a free tool so it becomes the live version. |
free_tools_discard | free-tools discard | destructive | free-tools | Throw away the unpublished changes of a free tool and go back to the live version. |
free_tools_rollback | free-tools rollback | destructive | free-tools | Put the previous published version of a free tool back live. |
free_tools_attachments_add | free-tools attachments add | write | free-tools | Upload an image for the AI builder of a free tool, such as a screenshot or a mockup. |
free_tools_attachments_remove | free-tools attachments remove | destructive | free-tools | Remove a builder attachment of a free tool that was not sent with a change yet. |