# Hikoo

## Docs

- [Welcome to Hikoo](https://docs.tryhikoo.com/index.md): Track and improve how AI assistants cite your website.
- [Quickstart](https://docs.tryhikoo.com/quickstart.md): Set up your Hikoo account and see your first AI-visibility snapshot.
- [How Hikoo works](https://docs.tryhikoo.com/concepts/how-hikoo-works.md): The core concepts behind Hikoo: prompts, citations, share of voice, and AI readiness.
- [Dashboard](https://docs.tryhikoo.com/guides/dashboard.md): Get a bird's-eye view of your AI search visibility.
- [Citations](https://docs.tryhikoo.com/guides/citations.md): Track every time an AI assistant mentions or links your site in an answer
- [Prompts](https://docs.tryhikoo.com/guides/prompts.md): Define the natural-language questions Hikoo runs against AI assistants to test your visibility
- [Topics](https://docs.tryhikoo.com/guides/topics.md): Group prompts into themes that drive filtering across the dashboard
- [Search queries](https://docs.tryhikoo.com/guides/search-queries.md): See the sub-questions AI assistants search on your behalf while answering your prompts
- [Sentiment](https://docs.tryhikoo.com/guides/sentiment.md): Measure how positively or negatively AI assistants portray your brand and competitors
- [Agent analytics](https://docs.tryhikoo.com/guides/agent-analytics.md): See real AI agents and crawlers fetching pages on your own site
- [Competitors](https://docs.tryhikoo.com/guides/competitors.md): Benchmark your AI citation performance against competitors with the Battlemap
- [Source intelligence](https://docs.tryhikoo.com/guides/source-intelligence.md): Find the third-party sources AI assistants pull from and see where your brand is absent
- [Elevate](https://docs.tryhikoo.com/guides/elevate.md): Find the topics and questions competitors get cited for in AI answers but you do not
- [Audit](https://docs.tryhikoo.com/guides/audit.md): Run an on-demand AI-readiness evaluation of your site or specific pages and track your score over time
- [Website health](https://docs.tryhikoo.com/guides/health.md): See whether your site is technically ready to be discovered and cited by AI
- [Pages](https://docs.tryhikoo.com/guides/pages.md): Browse the pages Hikoo has indexed for your site, with category, language, and status for each
- [Marketing plan](https://docs.tryhikoo.com/guides/marketing-plan.md): Turn your Hikoo findings into an actionable GEO task board
- [Websites](https://docs.tryhikoo.com/guides/websites.md): Track multiple websites from one account, each with its own prompts, citations, competitors, and audits.
- [Workspaces](https://docs.tryhikoo.com/guides/workspaces.md): Organize websites and teammates under a workspace with its own roles and subscription.
- [Settings](https://docs.tryhikoo.com/guides/settings.md): Manage your profile, preferences, security, API keys, team, and billing from one modal.
- [API keys](https://docs.tryhikoo.com/guides/api-keys.md): Create and manage keys that authenticate the Hikoo REST API and MCP server.
- [Free tools](https://docs.tryhikoo.com/guides/free-tools.md): Public tools on tryhikoo.com that check a site's AI readiness with no account.
- [MCP overview](https://docs.tryhikoo.com/guides/mcp/overview.md): Use Claude and other AI assistants to explore your Hikoo data through the Model Context Protocol.
- [Connecting the MCP](https://docs.tryhikoo.com/guides/mcp/setup.md): Generate an API key and wire up Claude Desktop, Claude Code, or any MCP client to your Hikoo account.
- [Tools reference](https://docs.tryhikoo.com/guides/mcp/tools.md): Every tool the Hikoo MCP exposes, grouped by area.
- [REST API overview](https://docs.tryhikoo.com/api-reference/introduction.md): Programmatic access to your Hikoo data: citations, prompts, competitors, audits, health and more.
- [Get Me](https://docs.tryhikoo.com/api-reference/account/get-me.md): Return the user the API key is bound to.
- [List Workspaces](https://docs.tryhikoo.com/api-reference/workspaces/list-workspaces.md): List every workspace the user is a member of (excludes soft-deleted).
- [List Workspaces With Websites](https://docs.tryhikoo.com/api-reference/workspaces/list-workspaces-with-websites.md): Workspaces the user belongs to, each with its websites nested inside.
- [List Websites](https://docs.tryhikoo.com/api-reference/websites/list-websites.md): List websites the user can access, paginated.
- [Get Website](https://docs.tryhikoo.com/api-reference/website/get-website.md): Return the website detail (subscription, plan, settings) for the given website_id.
- [Get Subscription Details](https://docs.tryhikoo.com/api-reference/website/get-subscription-details.md): Plan info for the website: plan tier, product name, status, trial/expiry dates, AI platforms covered, feature flags, and quotas. Agents use this to tell the user which features require an upgrade.
- [Get Audits Quota](https://docs.tryhikoo.com/api-reference/audits/get-audits-quota.md): Audit quota usage (used / limit / remaining) for the current billing period. Call before ``hk_start_audit`` to avoid hitting the cap.
- [List Audits](https://docs.tryhikoo.com/api-reference/audits/list-audits.md): List all audits for the target website (most recent first).
- [Create Audit](https://docs.tryhikoo.com/api-reference/audits/create-audit.md): Queue a new full-site audit for the target website.
- [Audit Single Url](https://docs.tryhikoo.com/api-reference/audits/audit-single-url.md): Audit a single URL on the website. URL must belong to the website's domain.
- [Audit Selected Pages](https://docs.tryhikoo.com/api-reference/audits/audit-selected-pages.md): Audit a specific list of URLs on the website. All URLs must belong to the website's domain. The number of URLs is capped by the plan's ``audit_pages_per_month_per_website`` quota.
- [Sync Audit](https://docs.tryhikoo.com/api-reference/audits/sync-audit.md): Queue a new audit that reuses the page set and criteria of a previously completed audit. Cheap way to re-check the same surface after content changes.
- [Get Audit](https://docs.tryhikoo.com/api-reference/audits/get-audit.md): Retrieve a specific audit with its audited pages.
- [Get Audit Page](https://docs.tryhikoo.com/api-reference/audits/get-audit-page.md): Detail of a single audit page, including every criterion (validated or not) and the recommendations attached to each.
- [List Citations](https://docs.tryhikoo.com/api-reference/citations/list-citations.md): Paginated list of AI citations for the target website (full content, sources, competitors).
- [Get Top Platforms](https://docs.tryhikoo.com/api-reference/citations/get-top-platforms.md): Top AI platforms by citation count for the target website.
- [Get Platforms Share Of Voice](https://docs.tryhikoo.com/api-reference/citations/get-platforms-share-of-voice.md): Visibility trend data per platform for the target website.
- [Get Top Sources](https://docs.tryhikoo.com/api-reference/citations/get-top-sources.md): Top source domains (or URLs) appearing in AI citations for the target website.
- [Get Sentiment Summary](https://docs.tryhikoo.com/api-reference/citations/get-sentiment-summary.md): Aggregated sentiment per brand (tracked website + competitors + unresolved mentions) over the requested period.
- [Get Sentiment Trend](https://docs.tryhikoo.com/api-reference/citations/get-sentiment-trend.md): Sentiment counts bucketed over time (day or week).
- [Get Citations Breakdown](https://docs.tryhikoo.com/api-reference/citations/get-citations-breakdown.md): Per-match_type counts (brand_citation / site_mention / background_source) over the requested period, with delta vs previous period and a daily sparkline. Powers trend cards.
- [Get All Source Urls](https://docs.tryhikoo.com/api-reference/citations/get-all-source-urls.md): Full list of source URLs cited in AI responses, paginated and sorted by frequency. Unlike /top-sources this is not capped at 50 entries.
- [Get Citation](https://docs.tryhikoo.com/api-reference/citations/get-citation.md): Single citation by id: full content, sources, brand_mentions, prompt, competitor ranks. ``brand_mentions`` is stripped when the website's plan disables sentiment analysis.
- [Get Competitors Ranking](https://docs.tryhikoo.com/api-reference/competitors/get-competitors-ranking.md): Competitor ranking (share of voice) for the target website.
- [Add Competitor](https://docs.tryhikoo.com/api-reference/competitors/add-competitor.md): Add a competitor to the website. Plan quota (``competitors_limit``) is enforced inside the manager.
- [List Competitor Suggestions](https://docs.tryhikoo.com/api-reference/competitors/list-competitor-suggestions.md): List competitor candidates surfaced by the citation analyzer.
- [Dismiss Competitor Suggestion](https://docs.tryhikoo.com/api-reference/competitors/dismiss-competitor-suggestion.md): Dismiss a suggested competitor (hides it from future lists).
- [Promote Competitor Suggestion](https://docs.tryhikoo.com/api-reference/competitors/promote-competitor-suggestion.md): Promote a suggested competitor to a tracked Competitor row.
- [Update Competitor](https://docs.tryhikoo.com/api-reference/competitors/update-competitor.md): Update a competitor's name, URL, or aliases.
- [Delete Competitor](https://docs.tryhikoo.com/api-reference/competitors/delete-competitor.md): Remove a tracked competitor from the website.
- [Get Competitor Citations](https://docs.tryhikoo.com/api-reference/competitors/get-competitor-citations.md): Citation counts per competitor for the requested period.
- [Get Competitors Chart](https://docs.tryhikoo.com/api-reference/competitors/get-competitors-chart.md): Share of voice chart data for the website and its competitors.
- [Get Competitive Share Over Time](https://docs.tryhikoo.com/api-reference/competitors/get-competitive-share-over-time.md): Citation share of voice over time for the target website (vs all competitors).
- [Get Competitors Quota](https://docs.tryhikoo.com/api-reference/competitors/get-competitors-quota.md): Plan-based competitor quota for the website.
- [Get Content Gap Quota](https://docs.tryhikoo.com/api-reference/content-gaps/get-content-gap-quota.md): Monthly content-gap analysis quota for the website.
- [Get Content Gap Summary](https://docs.tryhikoo.com/api-reference/content-gaps/get-content-gap-summary.md): Summary stats for content gap suggestions: counts by status, priority, etc.
- [List Content Gaps](https://docs.tryhikoo.com/api-reference/content-gaps/list-content-gaps.md): Paginated content-gap suggestions sorted by similarity score (lowest first means biggest gaps).
- [Get Content Gap](https://docs.tryhikoo.com/api-reference/content-gaps/get-content-gap.md): Full detail of a content-gap suggestion: brief, outline, reasoning, similar competitor topic, closest existing page on the website.
- [Get Health](https://docs.tryhikoo.com/api-reference/health/get-health.md): Global health (AI crawlers allowed, llms.txt, sitemap) + improvement suggestions.
- [Refresh Health](https://docs.tryhikoo.com/api-reference/health/refresh-health.md): Force a re-check of robots.txt, llms.txt, and sitemap. Quota-limited by the plan's ``health_refresh_monthly_website_limit``.
- [Get Health Refresh Quota](https://docs.tryhikoo.com/api-reference/health/get-health-refresh-quota.md): Plan-based quota usage for health refreshes in the current billing period.
- [Dismiss Suggestion](https://docs.tryhikoo.com/api-reference/health/dismiss-suggestion.md): Dismiss a health suggestion so it stops appearing in the overview.
- [Restore Suggestion](https://docs.tryhikoo.com/api-reference/health/restore-suggestion.md): Restore a previously dismissed health suggestion.
- [Regenerate Suggestions](https://docs.tryhikoo.com/api-reference/health/regenerate-suggestions.md): Regenerate health suggestions from currently indexed pages. Plan-limited by ``suggestion_regen_monthly_website_limit``.
- [Get Suggestion Regen Quota](https://docs.tryhikoo.com/api-reference/health/get-suggestion-regen-quota.md): Plan-based quota usage for suggestion regenerations in the current billing period.
- [Get Suggestion Pages](https://docs.tryhikoo.com/api-reference/health/get-suggestion-pages.md): Paginated list of indexed pages affected by a health suggestion.
- [Get Indexation Summary](https://docs.tryhikoo.com/api-reference/indexation/get-indexation-summary.md): Aggregated stats on indexed pages: total, by category, health pass rate, pages with errors or warnings, last crawl timestamp.
- [Get Indexation Status](https://docs.tryhikoo.com/api-reference/indexation/get-indexation-status.md): Latest indexation job status (running, completed, failed) plus progress counters.
- [List Pages](https://docs.tryhikoo.com/api-reference/indexation/list-pages.md): Paginated list of indexed pages, with filters on category, health, errors, warnings, language, and URL/title search.
- [Get Page](https://docs.tryhikoo.com/api-reference/indexation/get-page.md): Detail of one indexed page: URL, title, language, category, last crawled at, errors.
- [List Page Errors](https://docs.tryhikoo.com/api-reference/indexation/list-page-errors.md): Most common health-check errors across the website's indexed pages.
- [Index Url](https://docs.tryhikoo.com/api-reference/indexation/index-url.md): Trigger a re-crawl of a single URL on the website. The URL must belong to the website's domain. Returns a job handle.
- [Get Prompts Quota](https://docs.tryhikoo.com/api-reference/prompts/get-prompts-quota.md): Return the current prompt count, subscription limit, and remaining slots.
- [List Prompts](https://docs.tryhikoo.com/api-reference/prompts/list-prompts.md): List prompts grouped by topic, each with its visibility score.
- [Create Prompt](https://docs.tryhikoo.com/api-reference/prompts/create-prompt.md): Create a new prompt. Fails if the website's prompt quota is reached.
- [Update Prompt](https://docs.tryhikoo.com/api-reference/prompts/update-prompt.md): Update an existing prompt.
- [Delete Prompt](https://docs.tryhikoo.com/api-reference/prompts/delete-prompt.md): Delete a prompt.
- [Get Prompt Citations](https://docs.tryhikoo.com/api-reference/prompts/get-prompt-citations.md): Paginated citations tied to a specific prompt.
- [Get Prompt Detail](https://docs.tryhikoo.com/api-reference/prompts/get-prompt-detail.md): Aggregate payload for prompt drill-down: visibility + 7d delta, best rank with platform, coverage X/N, 30-day sparkline, per-platform coverage grid, and the latest N answers in a single round trip.
- [Get Prompt Stats](https://docs.tryhikoo.com/api-reference/prompts/get-prompt-stats.md): Aggregated visibility stats for a prompt across every citation.
- [List Search Queries](https://docs.tryhikoo.com/api-reference/search-queries/list-search-queries.md): Unique AI search query variants executed for the website, aggregated and paginated.
- [Get Prompt Search Queries](https://docs.tryhikoo.com/api-reference/search-queries/get-prompt-search-queries.md): Unique search queries variants executed for a specific prompt.
- [Get Citation Search Queries](https://docs.tryhikoo.com/api-reference/search-queries/get-citation-search-queries.md): All search query variants attached to a single citation. Useful for debugging which AI sub-question generated a citation.
- [List Sources](https://docs.tryhikoo.com/api-reference/source-intelligence/list-sources.md): List suggested sources for the target website, ordered by citation count desc.
- [Get Stats](https://docs.tryhikoo.com/api-reference/source-intelligence/get-stats.md): Aggregated stats: counts by source type and by platform.
- [List Topics](https://docs.tryhikoo.com/api-reference/topics/list-topics.md): List all topics tracked for the target website.
- [Create Topic](https://docs.tryhikoo.com/api-reference/topics/create-topic.md): Create a new topic for the target website.
- [Update Topic](https://docs.tryhikoo.com/api-reference/topics/update-topic.md): Rename a topic.
- [Delete Topic](https://docs.tryhikoo.com/api-reference/topics/delete-topic.md): Delete a topic from the website.

## OpenAPI Specs

- [openapi](https://docs.tryhikoo.com/api-reference/openapi.json)