# AthenaHQ

## Docs

- [Getting Started](https://docs.athenahq.ai/getting-started/setup.md): Set up AthenaHQ and start tracking your brand across AI search
- [Discover](https://docs.athenahq.ai/discover.md): Run prompt discovery across your website, search data, social signals, and competitor gaps to find the prompts worth tracking
- [Setting Up Your Prompts](https://docs.athenahq.ai/setting-up-prompts.md): Build a useful Athena prompt set with direct entry or the Discover tab
- [Brand Profile](https://docs.athenahq.ai/brand-profile.md): Set up the brand details Athena uses for tracking, scoring, and content generation
- [Knowledge Base](https://docs.athenahq.ai/knowledge-base.md): Give Athena verified facts about your business for accurate research and content generation
- [Integrations](https://docs.athenahq.ai/integrations.md): Connect analytics, CMS, dashboarding, and reporting tools to Athena
- [Oracle](https://docs.athenahq.ai/oracle.md): Find and fix inaccurate AI search statements about your brand
- [Sources](https://docs.athenahq.ai/sources.md): See which websites AI search engines cite across your tracked prompts
- [Add Website (Onboarding Wizard)](https://docs.athenahq.ai/guides/add-website.md): Guides a user through creating and configuring a new website (brand profile, region, competitors, prompts, GSC, and run schedule) before landing in the main app.
- [ChatGPT Ads](https://docs.athenahq.ai/guides/ads.md): Show which sponsored ads ChatGPT serves against the customer's tracked prompts, who is buying them, and daily trends.
- [Brand Profile](https://docs.athenahq.ai/guides/brand-profile.md): Central hub for managing a website's brand identity: basic profile info, brand attributes, content rules, brand voice/kits, and technical AI-crawler configuration (llms.txt, sitemap, schema, AI accessibility).
- [Competitors](https://docs.athenahq.ai/guides/competitors.md): Manage tracked competitors (and your own website's identifiers/domains), review discovered competitor suggestions, restore deleted competitors, and control historical reanalysis (backfill) of competitor/identifier changes.
- [Content Hub](https://docs.athenahq.ai/guides/content.md): A spreadsheet-style hub for creating, importing, tracking, enriching with AI agent columns, and publishing all of a website's content.
- [Create Pitch Report](https://docs.athenahq.ai/guides/create-pitch.md): A two-step wizard for analyzing a website and generating (or cloning) a pitch report with competitors and prompts before creating it.
- [Glossary](https://docs.athenahq.ai/guides/glossary.md): Provides a searchable, categorized reference of plain-language definitions for every metric, score, and concept used across AthenaHQ.
- [Competitor Heatmap](https://docs.athenahq.ai/guides/heatmap.md): Show a matrix of brand vs. competitors across topics with mention/citation percentages so users can spot visibility gaps and drill into specific competitor+topic prompts.
- [Home (Ask Athena chat landing page)](https://docs.athenahq.ai/guides/home.md): A minimal chat-first landing page where users type or pick a suggested prompt to start a conversation with Athena AI about their brand's AI search presence.
- [Insights](https://docs.athenahq.ai/guides/insights.md): Shows a prioritized queue of AI-generated insights and content-opportunity recommendations for growing the website's AI-search visibility, with tools to act on, resolve, or discard each one.
- [Olympus (Dashboard)](https://docs.athenahq.ai/guides/olympus.md): The main analytics dashboard for a website, showing customizable cards on brand visibility, share of voice, citations, sentiment, and business value in AI search results.
- [Oracle](https://docs.athenahq.ai/guides/oracle.md): Runs and reviews AI-response accuracy checks and fact verification against a brand's knowledge base, surfacing discrepancies for the team to resolve.
- [Outreach](https://docs.athenahq.ai/guides/outreach.md): Triage pages that AI cites, find the author/contact info, draft outreach emails, and track outreach progress through a pipeline.
- [Report Builder (Edit Report)](https://docs.athenahq.ai/guides/reports-id.md): Lets a user edit an existing scheduled report's charts, name, delivery schedule, and recipients, and preview or manually send the report.
- [Responses](https://docs.athenahq.ai/guides/responses.md): Browse and inspect every individual AI-model response captured for the tracked prompts, with rich filtering, column customization, and a detail drawer.
- [Shopping Insights](https://docs.athenahq.ai/guides/shopping.md): Show how the tracked website's products appear in AI shopping/product-carousel results, benchmarked against competitors.
- [Group Dashboard](https://docs.athenahq.ai/guides/group-id.md): Show combined AI-search visibility metrics (share of voice, mention/citation rate, position, dollar value) across all websites in a group, with filters and saved views.
- [Group Billing](https://docs.athenahq.ai/guides/group-id-billing.md): Lets a group admin/billing-authorized user enable shared billing for a website group, buy or manage credits pooled across that group's websites, and view the group's invoice history.
- [Knowledge Base](https://docs.athenahq.ai/guides/knowledge-base.md): Central workspace for building, curating, and verifying a website's AI-answer knowledge base: pillars (topics), source claims/facts, internal link bank, and unfiled facts.
- [Review pending claims](https://docs.athenahq.ai/guides/knowledge-base-review.md): Lets a Knowledge Base user triage all AI-extracted claims that need human approval before they can count toward published pillars, with per-claim and bulk approve/reject/delete/assign actions.
- [Knowledge Base Pillar Detail](https://docs.athenahq.ai/guides/knowledge-base-pillarId.md): Detail page for a single Knowledge Base pillar (topic), where users review/manage its claims, sources, associated pages, generated document, and matching content.
- [Pitch Workspace Report](https://docs.athenahq.ai/guides/pitch-workspace.md): Shows the full AI-visibility report (share of voice, brand mentions, model performance, competitor analysis, citation sources, and underlying AI responses) for the organization's currently active pitch.
- [Pitch Setup](https://docs.athenahq.ai/guides/pitch-workspace-setup.md): Read-only view of a selected pitch's basic info, identifiers, tracked competitors, and analysis prompts.
- [Pitch Workspace Usage](https://docs.athenahq.ai/guides/pitch-workspace-usage.md): Shows how many Pitch Workspace reports an organization has used against its plan quota (or confirms unlimited usage) alongside a static explainer of what pitch reports include.
- [Content Pitches List (Pitch Workspace → Content)](https://docs.athenahq.ai/guides/pitch-workspace-content.md): Lists an organization's content pitches: shareable AI-generated rewrite reports created to pitch prospects, with actions to create, open, share, or delete each one.
- [Content Pitch Detail](https://docs.athenahq.ai/guides/pitch-workspace-content-id.md): Lets an org member preview, share, and delete one AI-generated content pitch report exactly as the prospect would see it, with workspace-only management controls layered on top.
- [Create Content Pitch](https://docs.athenahq.ai/guides/pitch-workspace-content-create.md): Two-step wizard where an agency user pastes a prospect's article URL, has Athena analyze it and draft AI-search prompts, then generates a shareable public 'content pitch' report showing rewrite suggestions.
- [Prompts](https://docs.athenahq.ai/guides/prompts.md): Central workspace for managing tracked prompts (and their topics), plus tabs for Personas, Locations, and Discover: the core surface for building and organizing what Athena asks AI models on the customer's behalf.
- [Discovery Run Detail (Discover a Run's Suggested Prompts)](https://docs.athenahq.ai/guides/prompts-discover-id.md): Shows the prompts a single Discover run found, grouped by topic, so a user can review, filter, and start tracking (or remove) the AI-suggested prompts.
- [Public AI Search Report](https://docs.athenahq.ai/guides/report-pitchId.md): Public, shareable read-only AI search performance report for a single pitch/brand, showing share of voice, model performance, brand traits, citation sources, competitor landscape, and underlying AI responses.
- [Public Content Suggestions Report](https://docs.athenahq.ai/guides/report-content-shareId.md): A public, no-login page where anyone holding the shareable link can read an AI-rewritten version of a prospect's article with Athena's inline 'Before/After/Why' content suggestions highlighted.
- [API & MCP Settings](https://docs.athenahq.ai/guides/settings-api.md): Lets org/website admins create and manage API keys, view API/MCP/Looker Studio setup instructions, and configure embed (iframe) credentials for embedding the AthenaHQ dashboard elsewhere.
- [Settings → Users (Team & Access)](https://docs.athenahq.ai/guides/settings-users.md): Manage everyone who has access to the organization, its websites, and groups: invite, view, change roles, move between org/website scope, and revoke access.
- [Settings – Billing](https://docs.athenahq.ai/guides/settings-billing.md): Lets a website member or organization admin view and manage their AthenaHQ subscription plan, credit balances/usage, invoices, and website/group billing allocations.
- [Domain Access Settings](https://docs.athenahq.ai/guides/settings-domains.md): Lets organization admins configure email-domain-based auto-join rules that grant new users automatic access to the whole organization or to a specific subset of websites.
- [Settings → General (Organization Details)](https://docs.athenahq.ai/guides/settings-general.md): Lets an organization member view core org details, manage SSO/SCIM provisioning settings, and (if owner) delete the organization, plus discover other org settings via quick links.
- [Settings – Profile](https://docs.athenahq.ai/guides/settings-profile.md): Lets a signed-in user manage their personal name/avatar, view their role, choose a sidebar preset, and delete their account.
- [Activity Log (Settings › Activity)](https://docs.athenahq.ai/guides/settings-activity.md): Review and export a chronological audit trail of tracked changes across your organization and websites.
- [Integrations](https://docs.athenahq.ai/guides/settings-integrations.md): Connect, configure, and disconnect third-party integrations (analytics, CMS/publishing platforms, and reporting/collaboration tools) for the active website.
- [Shopping Pages](https://docs.athenahq.ai/guides/shopping-pages.md): Central workspace for creating, publishing, and measuring AI-optimized product listing (PLP) and product detail (PDP) pages, their underlying product catalog, and experiments to improve them.
- [Shopping Pages – Branding Editor](https://docs.athenahq.ai/guides/shopping-pages-branding.md): Lets an admin edit and publish a website's shared brand styling (colors, fonts, logo, header/footer chrome) previewed on a placeholder storefront page.
- [Shopping Page Content Editor](https://docs.athenahq.ai/guides/shopping-pages-editor-plpId.md): Visual editor for a single shopping product-listing page's content (or, in experiment mode, its Version B candidate), letting admins edit copy/images, manage its template assignment, and save/publish.
- [PDP Layout Editor](https://docs.athenahq.ai/guides/shopping-pages-editor-pdp-pdpId.md): Full-screen visual editor for designing and publishing the layout of a single product detail page (PDP) in Shopping Pages.
- [Shopping Pages Template Editor](https://docs.athenahq.ai/guides/shopping-pages-templates-templateId-editor.md): Lets admins visually edit the structure and default content of a shared PLP template (used across a website's product-listing pages) and publish changes live.
- [Sources](https://docs.athenahq.ai/guides/sources.md): Lets customers see which domains/URLs AI models cite for their brand, broken down by domain or page and filterable by model/prompt/social platform, with drill-down, tagging, and export tools.
- [Source Domain Analytics (Sources drill-down)](https://docs.athenahq.ai/guides/sources-root_domain.md): Deep-dive view for a single cited root domain, showing which URLs/prompts/responses cite it, its citation trend, and (for YouTube) creator/timestamp breakdowns.
- [Sources Visualization](https://docs.athenahq.ai/guides/sources-visualization.md): Shows an interactive Sankey diagram of which web sources LLMs cite when mentioning the brand or its competitors, so users can find high-value sources, competitor intel, and content gaps.
- [Source URL Analytics](https://docs.athenahq.ai/guides/sources-analytics-source_url.md): Deep-dive inspector for a single cited URL (or YouTube video), showing its responses, URL parameter variants, and (for YouTube) creator/timestamp breakdowns
- [Introduction](https://docs.athenahq.ai/api-reference/introduction.md): Programmatically interact and integrate with AthenaHQ
- [Authentication](https://docs.athenahq.ai/api-reference/authentication.md): Authenticate API requests using API keys
- [Single Sign-On (SSO)](https://docs.athenahq.ai/api-reference/sso.md): Configure SAML or OIDC single sign-on for your AthenaHQ organization
- [Rate Limits](https://docs.athenahq.ai/api-reference/rate-limits.md): API rate limits and availability
- [Changelog](https://docs.athenahq.ai/api-reference/changelog.md): Latest updates and changes to the AthenaHQ API
- [MCP Server](https://docs.athenahq.ai/api-reference/mcp.md): Connect AthenaHQ to ChatGPT, Claude, and other AI assistants via the Model Context Protocol
- [Looker Studio](https://docs.athenahq.ai/api-reference/looker-studio.md): Integrate AthenaHQ with Looker Studio
- [Power BI & Microsoft Fabric](https://docs.athenahq.ai/api-reference/powerbi-fabric.md): Pull AthenaHQ data into Power BI Desktop, Power BI Service, or Microsoft Fabric via the REST API
- [Validate API Key](https://docs.athenahq.ai/api-reference/basics/validate-api-key.md): Validates an API key.
- [Get Date Range](https://docs.athenahq.ai/api-reference/basics/get-date-range.md): Returns the date range with available data for a website's prompts. Use this to determine the valid date range for other API queries.
- [Get Websites](https://docs.athenahq.ai/api-reference/basics/get-websites.md): Returns all active websites associated with your API key. **Partner integrations** may pass `external_id` as a query parameter to find the Athena website mapped to a partner-supplied identifier.
- [Create Website](https://docs.athenahq.ai/api-reference/basics/create-website.md): Creates a new website in your organization. The website will be created with onboarding step 1, ready for further configuration. **Partner integrations** may include an `external_id` to map their own identifier onto the new Athena website.
- [Provision Website](https://docs.athenahq.ai/api-reference/basics/provision-website.md): Creates a fully configured website in a single call, skipping the onboarding wizard. Optionally configures competitors, prompts, and a processing schedule. Requires a global API key. **Partner integrations** may include an `external_id` to map their own identifier onto the new Athena website.
- [Delete Website](https://docs.athenahq.ai/api-reference/basics/delete-website.md): Deletes a website. Removes it from your organization and stops all associated processing. Requires a global API key. Idempotent: re-calling on an already deleted website returns 200. This action is reversible — call `POST /api/v1/websites/{website_id}/restore` to reactivate a deleted website.
- [Restore Website](https://docs.athenahq.ai/api-reference/basics/restore-website.md): Restores a previously deleted website, reactivating processing and making it available again. All historical data is preserved. Requires a global API key. Idempotent: re-calling on an already active website returns 200.
- [Get Prompts](https://docs.athenahq.ai/api-reference/basics/get-prompts.md): Returns all prompts for a specific website. You can optionally filter by status (active or paused). The prompts returned include metadata such as monthly search volume and total value.
- [Create Prompts](https://docs.athenahq.ai/api-reference/basics/create-prompts.md): Creates one or more prompts on a website. Returns the created prompt ids. Each prompt's geography (`countries` / `primary_country`) and any attached `location_ids` are validated for compatibility before insert.
- [Update Prompt](https://docs.athenahq.ai/api-reference/basics/update-prompt.md): Updates a prompt's metadata (text, type, volume, topic, geography, locations). Only the supplied fields change. Returns a before/after snapshot.
- [Pause or Unpause Prompts](https://docs.athenahq.ai/api-reference/basics/pause-or-unpause-prompts.md): Pauses or unpauses multiple prompts in one transaction.
- [Delete Prompt](https://docs.athenahq.ai/api-reference/basics/delete-prompt.md): Deletes a prompt. Soft-deletes when the prompt already has responses, otherwise hard-deletes.
- [Get Prompt Tags](https://docs.athenahq.ai/api-reference/basics/get-prompt-tags.md): Returns all prompt tags for a specific website, sorted by tag name, with the number of non-deleted prompts carrying each tag. Use the returned IDs with the `prompt_tags` filter on GET /api/v1/prompts or the `tag_ids` field on POST /api/v1/prompts.
- [Get Topics](https://docs.athenahq.ai/api-reference/basics/get-topics.md): Returns the active topics for a website, with the count of active prompts in each. Use it to resolve a topic name to its `id` before creating prompts or filtering.
- [Create Topic](https://docs.athenahq.ai/api-reference/basics/create-topic.md): Creates a topic on a website. Topics group prompts for aggregate reporting; pass the returned `id` as `prompts[].topic_id` when creating prompts. Get-or-create by name: if an active topic with the same name already exists, the existing topic is returned with `created: false` instead of failing, so r…
- [Update Topic](https://docs.athenahq.ai/api-reference/basics/update-topic.md): Updates a topic's name and/or description. Only the supplied fields change. Renaming to a name already used by another active topic on the website returns `400`. Renames don't affect metrics or prompt grouping — everything joins on the topic's `id`, not its name. Returns a before/after snapshot.
- [Delete Topic](https://docs.athenahq.ai/api-reference/basics/delete-topic.md): Soft-deletes a topic. By default its prompts are kept: they stay active, keep their history, remain grouped under the deleted topic in the app, and can be re-categorized later. Pass `delete_prompts=true` to also soft-delete every active prompt in the topic (they stop generating responses). Reversibl…
- [Get Personas](https://docs.athenahq.ai/api-reference/basics/get-personas.md): Returns all personas for a specific website, sorted by name, with the number of non-deleted prompts each persona is assigned to. Use the returned IDs to resolve `persona_id` values returned by other endpoints and tools to persona names and descriptions.
- [Get Competitors](https://docs.athenahq.ai/api-reference/basics/get-competitors.md): Returns all competitors for a specific website.
- [Get Locations](https://docs.athenahq.ai/api-reference/basics/get-locations.md): Returns all locations for a specific website.
- [Create Location](https://docs.athenahq.ai/api-reference/basics/create-location.md): Creates a location for a website. `country` is case-insensitive and stored as its canonical label. Any attached `prompt_ids` must allow the location's country.
- [Update Location](https://docs.athenahq.ai/api-reference/basics/update-location.md): Updates a location's name, country, and/or prompt associations. Only supplied fields change; omitting `prompt_ids` preserves existing associations. Returns a before/after snapshot.
- [Delete Location](https://docs.athenahq.ai/api-reference/basics/delete-location.md): Soft-deletes a location.
- [Query Responses](https://docs.athenahq.ai/api-reference/basics/query-responses.md): Returns paginated AI model responses for a website with optional filtering by date range, models, prompts, and competitors.
- [Start Response Streaming](https://docs.athenahq.ai/api-reference/basics/start-response-streaming.md): Kicks off a response-streaming run for a website: Athena queries the selected AI models for the website's prompts and ingests the responses. Omit `prompt_ids` to run every active prompt, or pass a selection (up to 1,000). Returns immediately with the `workflow_id` of the run and `status: "running"`;…
- [Get Response Streaming Status](https://docs.athenahq.ai/api-reference/basics/get-response-streaming-status.md): Returns the whole-run state and response-queue progress of a website's response-streaming run. By default reports the latest run; pass `workflow_id` to read a specific one. Progress measures response collection only, so `state` can remain `running` when `progress.percentage` is 100 while downstream…
- [Get Saved Views](https://docs.athenahq.ai/api-reference/basics/get-saved-views.md): Returns all saved views (filter presets) for a specific website. Each saved view captures a named set of filters that can be reused across the dashboard.
- [Get Group Saved Views](https://docs.athenahq.ai/api-reference/basics/get-group-saved-views.md): Returns all group-level saved views (filter presets) for the websites in a group. Group saved views capture filter state shared across the group rather than scoped to a single website.
- [List Attributes](https://docs.athenahq.ai/api-reference/attributes/list-attributes.md): Returns the brand-perception attributes (keywords) tracked for a website, such as 'Affordable' or 'Slow Support'. Athena extracts these from AI model responses. Use this to discover attribute ids, then POST /api/v1/attributes/cumulative for mention counts, or POST /api/v1/attributes/time-series for…
- [Cumulative Attribute Metrics](https://docs.athenahq.ai/api-reference/attributes/cumulative-attribute-metrics.md): Returns, for each brand-perception attribute, how many AI responses mentioned it across the date range, and the percentage. `total_responses` is the denominator: responses in the date range that mention the brand AND had attribute extraction run on them. It is NOT every response for the website — re…
- [Competitor Attribute Metrics](https://docs.athenahq.ai/api-reference/attributes/competitor-attribute-metrics.md): Returns attribute metrics per tracked competitor: for each competitor and each attribute, how many AI responses mentioned that keyword for that competitor. Pair with POST /api/v1/attributes/cumulative to compare the brand against competitors. `total_responses` is per-competitor: responses in the dat…
- [Attribute Time Series](https://docs.athenahq.ai/api-reference/attributes/attribute-time-series.md): Returns the daily trend for ONE attribute, brand and competitors side by side. Requires an attribute_id — call GET /api/v1/attributes first to discover ids. Days with no data are returned as zeros, so the series is gap-free and chartable. Denominators are per-side, not the day's whole response set:…
- [Cumulative Share of Voice](https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice.md): Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. Each entry also includes `relative_mention_rate`: the entry's mentions as a percentage of responses that mention at least one tracked brand.
- [Share of Voice Over Time](https://docs.athenahq.ai/api-reference/metrics/share-of-voice-over-time.md): Returns daily share of voice breakdown over the specified date range. Each entry contains the date and SOV percentages for your brand and competitors, plus each company's `relative_mention_rate`: its mentions as a percentage of that day's responses that mention at least one tracked brand.
- [Cumulative Mention Rate](https://docs.athenahq.ai/api-reference/metrics/cumulative-mention-rate.md): Returns mention rate percentages across the specified date range. `mention_rate` is absolute (the percentage of all AI responses that mention the brand); `relative_mention_rate` is the percentage of responses mentioning at least one tracked brand.
- [Mention Rate Over Time](https://docs.athenahq.ai/api-reference/metrics/mention-rate-over-time.md): Returns daily mention rate breakdown over the specified date range. Each entry contains the date and, per brand/competitor, the absolute `mention_rate` (share of all responses that day) and `relative_mention_rate` (share of that day's responses mentioning at least one tracked brand).
- [Cumulative Citation Rate](https://docs.athenahq.ai/api-reference/metrics/cumulative-citation-rate.md): Returns citation rate percentages across the specified date range. Shows the percentage of AI responses that cite your brand and competitors as sources.
- [Citation Rate Over Time](https://docs.athenahq.ai/api-reference/metrics/citation-rate-over-time.md): Returns daily citation rate breakdown over the specified date range. Each entry contains the date and citation rate percentages for your brand and competitors.
- [Cumulative Position](https://docs.athenahq.ai/api-reference/metrics/cumulative-position.md): Returns average position/ranking across the specified date range. Shows where your brand and competitors typically appear in AI responses.
- [Position Over Time](https://docs.athenahq.ai/api-reference/metrics/position-over-time.md): Returns daily position/ranking breakdown over the specified date range. Each entry contains position metrics for your brand and competitors.
- [AI Search Value](https://docs.athenahq.ai/api-reference/ai-search-value.md): Read the estimated monthly dollar value of a website's presence in AI search answers, as a range grounded in Google keyword economics.
- [Get AI Search Value](https://docs.athenahq.ai/api-reference/ai-search-value/get-ai-search-value.md): AI Search Value for a website: topic-market value, captured value range, headroom, coverage, value-weighted AI share of voice, per-topic detail, and modeled attributed contribution.
- [List Content Hub Sheets](https://docs.athenahq.ai/api-reference/content/list-content-hub-sheets.md): Returns the Content Hub tabs configured for a website. Each tab is either a `sheet` (content pinned via `content.sheet_id`) or a `view` (saved filter layout over the main content pool). Call this first to discover the `sheet_id`s you can pass to `POST /api/v1/content`.
- [List Tracked Content](https://docs.athenahq.ai/api-reference/content/list-tracked-content.md): Returns paginated tracked content with citation, impression, and response metrics joined for the requested date range. Hidden content (`is_hidden = true`) is excluded.
- [Get Content Detail](https://docs.athenahq.ai/api-reference/content/get-content-detail.md): Fetch the full detail of a single tracked content item — including the actual text: the content brief (`brief`) and the article/page body (`body`). `body` holds generated drafts, optimize rewrites, snipe articles, authored text, and scraped tracked-page bodies alike.
- [Per-Content Prompt Citation Breakdown](https://docs.athenahq.ai/api-reference/content/per-content-prompt-citation-breakdown.md): For a single tracked content item, returns every prompt whose AI responses cite the URL — with citations, citation %, and estimated impressions for the date range.
- [Start Content Pipeline](https://docs.athenahq.ai/api-reference/content/start-content-pipeline.md): Start the content pipeline in one of four modes — draft (write new content from promptIds), snipe (outrank a competitor url), optimize (improve an existing url for AI search), slice (split one url into several articles). Required fields by mode: draft needs promptIds (resolve real prompt ids first —…
- [Get Content Pipeline Status](https://docs.athenahq.ai/api-reference/content/get-content-pipeline-status.md): Get the normalized pipeline status (running | succeeded | failed) for one content row, plus the raw stage behind it. Read-only. Poll once per contentId returned by create_content (content.pipeline.start). A stage of generated_brief with status running means the brief is ready and waiting: for a non-…
- [Get Content Draft](https://docs.athenahq.ai/api-reference/content/get-content-draft.md): Read the current draft text of a content item — the article body as it stands right now, including every revision applied so far. Use this before revise_content to see what you are changing, and after it to confirm the result. A status of generated_brief means the brief is ready while the article is…
- [Revise Content Brief](https://docs.athenahq.ai/api-reference/content/revise-content-brief.md): Rewrite a content brief from a natural-language instruction (for example: 'add a section on pricing objections', 'cut the competitor comparison'). An AI model performs the rewrite server-side, so the result is generated text, not your literal wording. Records each pass as a version; iterate by calli…
- [Approve Content Brief](https://docs.athenahq.ai/api-reference/content/approve-content-brief.md): Approve a content brief and start writing the article from it. Only valid while the piece is at status generated_brief. The article is generated from the brief exactly as it currently stands, including any revisions made with revise_brief or edits made in the app. Consumes content credits; poll get_…
- [Revise Content Draft](https://docs.athenahq.ai/api-reference/content/revise-content-draft.md): Rewrite an existing content draft from a natural-language instruction (for example: 'tighten the intro', 'add a section on pricing', 'remove the second half'). An AI model performs the rewrite server-side, so the result is generated text, not your literal wording; when you already have the exact rep…
- [Edit Content Draft](https://docs.athenahq.ai/api-reference/content/edit-content-draft.md): Apply exact find-and-replace edits to a content draft's article body. Deterministic, no AI model involved: your replacement text lands verbatim (use the revise endpoint when you want an AI rewrite from an instruction). Each edit's find text must match the current body exactly once; zero or multiple…
- [List Content Versions](https://docs.athenahq.ai/api-reference/content/list-content-versions.md): List the saved versions of a content item, newest first. Each entry carries its version number, label, how it was produced, and who made it. Use it to see how a draft evolved, then get_content_version to read a specific one, or restore_content_version to go back to it.
- [Get Content Version](https://docs.athenahq.ai/api-reference/content/get-content-version.md): Read the full text of one saved version of a content item. Use it to compare two passes (fetch both and diff them yourself) or to check what an earlier version said before restoring it.
- [Restore Content Version](https://docs.athenahq.ai/api-reference/content/restore-content-version.md): Bring an earlier version's text back as the current draft — use it when a later pass came out worse than an earlier one. Nothing is deleted: the restored text is appended as a new version on top of the history, so the passes in between remain readable and restorable.
- [Mark Content as Published](https://docs.athenahq.ai/api-reference/content/mark-content-as-published.md): Mark a content item as published at its live URL so Athena starts attributing citations and mentions to it. Call this only after the piece is actually live on the site: the URL becomes the item's citation/metric join key, the publish time is stamped, and the pipeline stage moves to done. A first pub…
- [Track External URLs](https://docs.athenahq.ai/api-reference/content/track-external-urls.md): Register existing pages or third-party URLs as tracked Content Hub items so Athena attributes citations and mentions to them. Creates external content rows from bare URLs with no generation and no credit cost. Tracking starts immediately: the normalized URL becomes the citation/metric join key, so p…
- [Rename Content](https://docs.athenahq.ai/api-reference/content/rename-content.md): Rename a content row's title. URL editing is not supported — URL is the content asset's stable identity and cannot be changed here.
- [Delete Content](https://docs.athenahq.ai/api-reference/content/delete-content.md): Delete a content row. Destructive: physical row delete, no undo. Powers delete-and-retry. Bulk delete is out of scope.
- [Search Brand Facts](https://docs.athenahq.ai/api-reference/knowledge-base/search-brand-facts.md): Semantic search over a website's approved brand facts. Combines vector similarity with full-text search, so it also reaches facts not filed under any pillar. Returns fact text with confidence, source URL and quote, and the published pillar it belongs to (null when unfiled). Also available as the MCP…
- [Get Brand Facts](https://docs.athenahq.ai/api-reference/knowledge-base/get-brand-facts.md): Lists a website's brand facts, newest first, with offset paging. By default excludes facts generated by Oracle analysis; pass `include_oracle=true` to include them. Filter by pillar, review status (defaults to approved), source type, or `unfiled=true` for facts not under any published pillar. `unfil…
- [Get Pillars](https://docs.athenahq.ai/api-reference/knowledge-base/get-pillars.md): Lists a website's Knowledge Base pillars (excluding archived ones) with approved-fact counts, whether a synthesized document exists, and when each pillar was last researched. Also available as the MCP tool `get_pillars`.
- [Get Pillar Document](https://docs.athenahq.ai/api-reference/knowledge-base/get-pillar-document.md): Fetches a pillar's synthesized markdown document. Returns `document: null` when the pillar exists but has no synthesized document yet (this is a 200, not a 404). Also available as the MCP tool `get_pillar_document`.
- [Add Brand Facts](https://docs.athenahq.ai/api-reference/knowledge-base/add-brand-facts.md): Adds brand facts to a website's Knowledge Base in bulk (1-50 per call). Every fact runs the full ingestion pipeline — deduplication, approval gates, and pillar routing — and there is no way to force-approve: inputs are declarative (text, optional source URL, optional pillar pin) and the response rep…
- [Update Brand Fact](https://docs.athenahq.ai/api-reference/knowledge-base/update-brand-fact.md): Updates one brand fact's text, source URL, or confidence. Only provided fields change; pass source_url: "" to clear the stored source. Editing text re-embeds the fact for semantic search; a 409 is returned when the new text collides with a sibling fact captured from the same AI response (duplicates…
- [Delete Brand Facts](https://docs.athenahq.ai/api-reference/knowledge-base/delete-brand-facts.md): Permanently deletes 1-50 brand facts from a website's Knowledge Base. There is no undo. Ids with no fact on the website are reported in not_found_ids instead of failing the call, so retries are idempotent. Requires a website-admin API key; on OAuth MCP connections the signed-in user must hold the ad…
- [Move Brand Facts](https://docs.athenahq.ai/api-reference/knowledge-base/move-brand-facts.md): Files 1-50 brand facts under a published Knowledge Base pillar. Works for unfiled facts and re-files facts from other pillars. Review status never changes, and only approved facts under a published pillar feed content generation, so moving is what puts approved facts to work. Ids with no fact on the…
- [Create Pillar](https://docs.athenahq.ai/api-reference/knowledge-base/create-pillar.md): Creates a Knowledge Base pillar (a subject area that groups brand facts) from a name and optional description. Get-or-create semantics: if a pillar with the same name already exists (case-insensitive), it is returned with `created: false` instead of failing, so retries and re-imports are idempotent.…
- [Update Pillar](https://docs.athenahq.ai/api-reference/knowledge-base/update-pillar.md): Updates a Knowledge Base pillar's name, description, or status. At least one of the three must be provided; only provided fields change. Renaming returns a 409 when another pillar already uses the name. Status accepts published or archived: archiving hides the pillar from pillar listings and stops i…
- [Delete Pillars](https://docs.athenahq.ai/api-reference/knowledge-base/delete-pillars.md): Permanently deletes 1-20 Knowledge Base pillars and every fact filed under them. Facts are deleted, not unfiled; there is no undo. Ids with no pillar on the website are reported in not_found_ids instead of failing the call, so retries are idempotent; ids in failed_ids are untouched and safe to retry…
- [Merge Pillars](https://docs.athenahq.ai/api-reference/knowledge-base/merge-pillars.md): Merges 1-20 source pillars into a published target pillar: every fact on the sources (any review status) re-files onto the target, page links carry over keeping the stronger signal, and the source pillars are then deleted. The target must be a published pillar and must not appear among the sources.…
- [List Pitches](https://docs.athenahq.ai/api-reference/pitch-workspace/list-pitches.md): Returns all non-deleted pitch workspace reports for the calling organization, ordered by creation date (newest first). Pitches are org-level resources and are not scoped to a single website.
- [Get Pitch Report](https://docs.athenahq.ai/api-reference/pitch-workspace/get-pitch-report.md): Returns a single pitch report by ID, including the company metadata, generated prompts, tracked competitors, brand and competitor attributes, top citing sources, and aggregate metrics (brand mentions, sentiment, response rate).
- [List Sources (by root domain)](https://docs.athenahq.ai/api-reference/sources/list-sources-by-root-domain.md): Returns the top cited sources for a website, grouped by root domain. Each row carries citation, mention, brand-mention, and impression metrics for the requested date range, plus a `default_source_type` classification (`owned` / `competitor` / `partner` / `third_party`).
- [List Source Pages (per URL)](https://docs.athenahq.ai/api-reference/sources/list-source-pages-per-url.md): Returns individual cited URLs for a website with citation, mention, and impression metrics — one row per `normalized_url`. Each row also includes a `daily_mentions` sparkline (citation percentage per day across the date range) and the same source-type classification as [POST /api/v1/sources](/api-re…
- [List Groups](https://docs.athenahq.ai/api-reference/groups/list-groups.md): Returns all groups for your organization, including associated websites. Requires a global API key. **Partner integrations** may pass `external_id` as a query parameter to find the Athena group mapped to a partner-supplied identifier. Partner responses additionally include `externalId` on each group…
- [Create Group](https://docs.athenahq.ai/api-reference/groups/create-group.md): Creates a new group with associated websites. Requires a global API key. **Partner integrations** may include an `external_id` to map their own identifier onto the new Athena group.
- [Get Group](https://docs.athenahq.ai/api-reference/groups/get-group.md): Returns a single group by ID, including associated websites. Requires a global API key. **Partner integrations** additionally receive an `externalId` field populated from the partner mapping (if any), and every website object inside `websites` carries its own `externalId` (`null` when that website h…
- [Update Group](https://docs.athenahq.ai/api-reference/groups/update-group.md): Updates a group's name, adds websites, removes websites, and/or (partners only) sets or clears the `external_id` mapping. At least one field must be provided. Requires a global API key. **Partner integrations** may pass `external_id` as a non-empty string to set/replace the mapping, or as `null` to…
- [Create Invite](https://docs.athenahq.ai/api-reference/team-management/create-invite.md): Invites a user to your organization, a specific website, or a group. Use `invite_method: "direct"` to add the user immediately without sending any email — if the email has no existing account, a new user account is created automatically. Use `invite_method: "email"` to create a pending invite and se…
- [Bulk Invite to Websites or Groups](https://docs.athenahq.ai/api-reference/team-management/bulk-invite-to-websites-or-groups.md): Invites a user to multiple websites OR multiple groups in a single request. Provide exactly one of `website_ids` or `group_ids` — the two are mutually exclusive. Each target is processed independently, so some may succeed while others fail (e.g., if the user is already a member). In 'email' mode a s…
- [Revoke Organization Invite](https://docs.athenahq.ai/api-reference/team-management/revoke-organization-invite.md): Soft-revokes a **pending** organization invite by setting its status to `revoked`. The invite row is preserved for audit purposes. Returns 409 if the invite is in any other state (already accepted, declined, expired, or revoked), since revoking an accepted invite would leave a misleading audit trail…
- [Revoke Website Invite](https://docs.athenahq.ai/api-reference/team-management/revoke-website-invite.md): Soft-revokes a **pending** website invite by setting its status to `revoked`. Accepts a global API key, or a website-scoped key if the invite's target website is included in the key's allowlist. Returns 409 if the invite is in any other state. To remove an already-accepted member, use `DELETE /api/v…
- [List Organization Members](https://docs.athenahq.ai/api-reference/team-management/list-organization-members.md): Returns all members of your organization, including user details (email, first/last name) and their organization role. Requires a global API key.
- [List Website Members](https://docs.athenahq.ai/api-reference/team-management/list-website-members.md): Returns all users with access to a website — both organization members (implicit access to every website in the org) and users with explicit website-member rows. Each entry includes an `access_type` field (`organization` or `website`) so you can tell them apart. If a user has both an org membership…
- [List Group Members](https://docs.athenahq.ai/api-reference/team-management/list-group-members.md): Returns all users with access to a group. By default, the response merges **organization members** (implicit access to every group in the org) and users with explicit **group-member rows**, tagging each entry with an `access_type` field (`organization` or `group`). If a user has both an org membersh…
- [Look Up User By Email](https://docs.athenahq.ai/api-reference/team-management/look-up-user-by-email.md): Resolves a user's `user_id` from their email address, scoped to your organization. The email is sent in the request body (not the URL) so it never lands in request logs or analytics. Returns the user only when they belong to your organization — either as an organization member (`access_type: "organi…
- [List User Websites](https://docs.athenahq.ai/api-reference/team-management/list-user-websites.md): Returns the websites that a user has access to within your organization, either via organization membership (implicit access to all websites in the org) or via explicit website membership. Organization membership takes precedence — if the user is an org member, all non-paused websites in your organi…
- [Remove User From Websites](https://docs.athenahq.ai/api-reference/team-management/remove-user-from-websites.md): Batch-removes a user's explicit website memberships within your organization. Pass the website IDs as a comma-separated list in the `website_ids` query parameter (at most 100). Requires a global API key. Idempotent: websites where the user has no explicit membership are reported with status `not_a_m…
- [Update Organization Member Role](https://docs.athenahq.ai/api-reference/team-management/update-organization-member-role.md): Updates an organization member's role. Accepts either the coarse `role` (admin/viewer) or a `role_id` — a system role or one of your organization's custom roles (see `GET /api/v1/roles`); provide exactly one. Requires a global API key. Cannot modify the API key's owning user or the organization owne…
- [Update Website Member Role](https://docs.athenahq.ai/api-reference/team-management/update-website-member-role.md): Updates a website member's role. Accepts a global API key, or a website-scoped key if the website is included in the key's allowlist. Cannot be used to modify the API key's owning user or the organization owner.
- [Update Group Member Role](https://docs.athenahq.ai/api-reference/team-management/update-group-member-role.md): Updates the role of a user who was explicitly added to a group (a `group_members` row, shown as `access_type: "group"` by `GET /api/v1/groups/{group_id}/members`). Accepts either the coarse `role` (admin/viewer) or a `role_id`: a system role or one of your organization's custom roles (see `GET /api/…
- [Remove Group Member Access](https://docs.athenahq.ai/api-reference/team-management/remove-group-member-access.md): Removes a user's direct group membership and their explicit website memberships for websites currently in the group. Both sets of rows are removed atomically. The request is idempotent: a retry, or a well-formed user ID with no matching membership rows, returns `200` with `group_membership_removed:…
- [Remove Organization Member](https://docs.athenahq.ai/api-reference/team-management/remove-organization-member.md): Removes a user from your organization. Also cleans up any stray website_members rows for that user across all websites in the organization within a single transaction. Requires a global API key. Cannot remove the API key's owning user, the organization owner, or the last remaining admin.
- [Remove Website Member](https://docs.athenahq.ai/api-reference/team-management/remove-website-member.md): Removes a user's explicit membership from a website. Accepts a global API key, or a website-scoped key if the website is included in the key's allowlist. Cannot be used to remove the API key's owning user or the organization owner.
- [List Roles](https://docs.athenahq.ai/api-reference/team-management/list-roles.md): Returns all roles available in your organization: the built-in system roles (Admin, Editor, Viewer, Billing) plus your organization's custom roles, each with its resolved permission matrix. Use a role's `role_id` to assign it via invites or member role updates. Requires a global API key.
- [Create Custom Role](https://docs.athenahq.ai/api-reference/team-management/create-custom-role.md): Creates a custom role with a per-category permission matrix. Custom roles are available on the Enterprise plan. Every category is at least 'view' — omitted categories default to 'view'. The role name must be unique in your organization and must not collide with a system role name; the permission mat…
- [Get Role](https://docs.athenahq.ai/api-reference/team-management/get-role.md): Returns a single role — a system role or one of your organization's custom roles — with its resolved permission matrix. Requires a global API key.
- [Update Custom Role](https://docs.athenahq.ai/api-reference/team-management/update-custom-role.md): Updates a custom role's permission matrix. Every category is at least 'view' — omitted categories default to 'view'. System roles cannot be edited. The new matrix must not duplicate an existing role's. Requires a global API key.
- [Delete Custom Role](https://docs.athenahq.ai/api-reference/team-management/delete-custom-role.md): Deletes a custom role. System roles cannot be deleted, and a role that is still assigned to members or pending invites (or set as a default role) cannot be deleted. Requires a global API key.
- [Get Website Credits](https://docs.athenahq.ai/api-reference/billing/get-website-credits.md): Returns the current credit balance for a specific website.
- [Get Organization Credits](https://docs.athenahq.ai/api-reference/billing/get-organization-credits.md): Returns the current credit balance for your organization.
- [Get Group Credits](https://docs.athenahq.ai/api-reference/billing/get-group-credits.md): Returns the current credit balance for a specific group. Requires a global API key.
- [Get Website Subscription](https://docs.athenahq.ai/api-reference/billing/get-website-subscription.md): Returns the subscription products for a specific website, including their status and billing dates.
- [Cancel Subscription](https://docs.athenahq.ai/api-reference/billing/cancel-subscription.md): Cancels a subscription for a specific website. The subscription will remain active until the end of the current billing period.
- [AI Access](https://docs.athenahq.ai/api-reference/ai-access.md): Programmatically check whether major AI answer engines can crawl a public domain.
- [Check AI accessibility for a domain](https://docs.athenahq.ai/api-reference/ai-access/check-ai-accessibility-for-a-domain.md): Probe a public domain to determine whether the major AI answer engines (ChatGPT, Claude, Perplexity, Gemini, Copilot, Grok, DeepSeek, Rufus) can crawl it. Returns the same per-model HTTP / robots.txt verdicts the AthenaHQ web app surfaces in its AI accessibility dialog, plus a plain-text diagnostic…

## OpenAPI Specs

- [openapi](https://docs.athenahq.ai/api-reference/openapi.json)