# ClarityQ Documentation

- [What is ClarityQ?](https://docs.clarityq.ai/get-started/what-is-clarityq.md): AI-powered data analytics that learns your business context and lets anyone ask questions in natural language.
- [Connect Your Data Warehouse](https://docs.clarityq.ai/get-started/connect-your-data-warehouse.md): Set up a secure connection between ClarityQ and your data warehouse.
- [Build Your Context Layer](https://docs.clarityq.ai/get-started/build-your-context-layer.md): Understand the Context Layer and the recommended order for building it.
- [Your First Chat](https://docs.clarityq.ai/get-started/your-first-chat.md): Ask your first data question in ClarityQ and understand what to expect.
- [Best Practices](https://docs.clarityq.ai/get-started/best-practices.md): Tips for getting the most accurate and useful answers from ClarityQ.
- [BigQuery](https://docs.clarityq.ai/data-warehouse/bigquery.md): Connect Google BigQuery to ClarityQ
- [Snowflake](https://docs.clarityq.ai/data-warehouse/snowflake.md): Connect Snowflake to ClarityQ
- [Amazon Athena](https://docs.clarityq.ai/data-warehouse/athena.md): Connect Amazon Athena to ClarityQ
- [Amazon Redshift](https://docs.clarityq.ai/data-warehouse/redshift.md): Connect Amazon Redshift to ClarityQ
- [PostgreSQL](https://docs.clarityq.ai/data-warehouse/postgres.md): Connect PostgreSQL to ClarityQ
- [Databricks](https://docs.clarityq.ai/data-warehouse/databricks.md): Connect Databricks to ClarityQ
- [MaxCompute](https://docs.clarityq.ai/data-warehouse/maxcompute.md): Connect Alibaba Cloud MaxCompute to ClarityQ
- [Trino](https://docs.clarityq.ai/data-warehouse/trino.md): Connect Trino to ClarityQ
- [ClickHouse](https://docs.clarityq.ai/data-warehouse/clickhouse.md): Connect ClickHouse to ClarityQ
- [What is the Context Layer?](https://docs.clarityq.ai/context-layer/what-is-the-context-layer.md): The Context Layer teaches ClarityQ how your business thinks about its data.
- [What is the Table Catalog?](https://docs.clarityq.ai/context-layer/table-catalog/what-is-the-table-catalog.md): A live inventory of your data warehouse tables, columns, and metadata.
- [Setting Up Your Table Catalog](https://docs.clarityq.ai/context-layer/table-catalog/setting-up-your-table-catalog.md): How to select tables and run the initial discovery process.
- [Daily Discovery Jobs](https://docs.clarityq.ai/context-layer/table-catalog/daily-discovery-jobs.md): How ClarityQ automatically detects schema changes and keeps your Table Catalog up to date.
- [What is the Event Catalog?](https://docs.clarityq.ai/context-layer/event-catalog/what-is-the-event-catalog.md): A real-time inventory of your product analytics events, including all their parameters and associated user properties.
- [Setting Up Your Event Catalog](https://docs.clarityq.ai/context-layer/event-catalog/setting-up-your-event-catalog.md): How to connect ClarityQ to your product analytics events and run the initial discovery.
- [Daily Discovery Jobs](https://docs.clarityq.ai/context-layer/event-catalog/daily-discovery-jobs.md): How ClarityQ keeps your Event Catalog in sync with the events flowing into your warehouse.
- [Missing Description Wizard](https://docs.clarityq.ai/context-layer/event-catalog/missing-description-wizard.md): Batch through every event, parameter, and user property still missing a description in one guided pass.
- [Syncing Events to the Semantic Catalog](https://docs.clarityq.ai/context-layer/event-catalog/syncing-events-to-the-semantic-catalog.md): Promote approved events from the Event Catalog into the Semantic Catalog so the agent can use them in analyses.
- [What is the Semantic Catalog?](https://docs.clarityq.ai/context-layer/semantic-catalog/what-is-the-semantic-catalog.md): The business logic layer that defines how your organization measures and analyzes data.
- [Entities](https://docs.clarityq.ai/context-layer/semantic-catalog/entities.md): Core data sources in the Semantic Catalog that represent your business objects.
- [Dimensions](https://docs.clarityq.ai/context-layer/semantic-catalog/dimensions.md): Properties used to filter and group data in your analyses.
- [Metrics](https://docs.clarityq.ai/context-layer/semantic-catalog/metrics.md): Standalone business calculations — your KPIs and derived numeric values.
- [Segments](https://docs.clarityq.ai/context-layer/semantic-catalog/segments.md): Reusable cohort definitions that filter users across any analysis.
- [Features](https://docs.clarityq.ai/context-layer/semantic-catalog/features.md): Tracked product events promoted from the Event Catalog into the Semantic Catalog.
- [Skills](https://docs.clarityq.ai/context-layer/skills.md): Reusable workflows the agent follows — invoked by you or automatically by the agent.
- [Rules](https://docs.clarityq.ai/context-layer/rules.md): Mandatory instructions attached to a single Semantic Catalog item, applied whenever the agent uses it.
- [Memory](https://docs.clarityq.ai/context-layer/memory.md): Persistent context that ClarityQ retains across conversations.
- [Recommended Build Order](https://docs.clarityq.ai/context-layer/building/recommended-build-order.md): The step-by-step order for building your Context Layer effectively.
- [How the Context Layer Builder works](https://docs.clarityq.ai/context-layer/building/how-the-context-layer-builder-works.md): The Context Builder (aka the Builder) is where your team drafts, validates, and deploys changes to the Context Layer.
- [Building Entities from Tables](https://docs.clarityq.ai/context-layer/building/building-entities-from-tables.md): Create semantic entities from your Table Catalog to power the Semantic Catalog.
- [Building Metrics](https://docs.clarityq.ai/context-layer/building/building-metrics.md): How to create, edit, and ship metrics through the Context Builder.
- [Building Segments](https://docs.clarityq.ai/context-layer/building/building-segments.md): How to create and edit reusable user cohort definitions through the Context Builder.
- [Building Skills](https://docs.clarityq.ai/context-layer/building/building-skills.md): How to create and edit custom skills through the Context Builder.
- [Building Product Memory](https://docs.clarityq.ai/context-layer/building/building-memory.md): How to create, edit, and manage product-level memory entries through the Context Builder.
- [Context Layer Versioning](https://docs.clarityq.ai/context-layer/building/context-layer-versioning.md): How drafts, versions, and releases work across the Context Layer.
- [Building Features from the Event Catalog](https://docs.clarityq.ai/context-layer/building/building-features-from-the-event-catalog.md): How events become queryable features in the Semantic Catalog.
- [How Ask Anything Works](https://docs.clarityq.ai/ask-anything/how-ask-anything-works.md): What happens behind the scenes when you ask ClarityQ a question.
- [Asking Questions](https://docs.clarityq.ai/ask-anything/asking-questions.md): How to ask effective questions using mentions, skills, date ranges, and filters.
- [Understanding Responses](https://docs.clarityq.ai/ask-anything/understanding-responses.md): What you see when ClarityQ answers your question — from reasoning to final visualization.
- [Diagnosing Answers](https://docs.clarityq.ai/ask-anything/diagnosing-answers.md): Investigate why an answer was wrong and get a suggested fix to your Context Layer.
- [Sharing & Collaboration](https://docs.clarityq.ai/ask-anything/sharing-and-collaboration.md): Share conversations, send to analysts, and collaborate on data questions.
- [Errors & Troubleshooting](https://docs.clarityq.ai/ask-anything/errors-and-troubleshooting.md): Common errors in Ask Anything and how to resolve them.
- [What are Dashboards?](https://docs.clarityq.ai/dashboards/what-are-dashboards.md): Interactive, AI-generated visualizations powered by live data from your warehouse.
- [Creating and Editing Dashboards](https://docs.clarityq.ai/dashboards/creating-and-editing-dashboards.md): How to create dashboards with the AI agent, edit them, and work with filters.
- [Asking About a Dashboard's Data](https://docs.clarityq.ai/dashboards/asking-about-dashboard-data.md): Dig deeper into what your dashboard shows by asking questions with its filters applied.
- [Scheduling Dashboards](https://docs.clarityq.ai/dashboards/scheduling-dashboards.md): Automate recurring dashboard snapshots and analyses delivered via email or Slack.
- [Sharing and Managing Dashboards](https://docs.clarityq.ai/dashboards/sharing-and-managing-dashboards.md): Publish, share, and organize your dashboards.
- [What are Tasks?](https://docs.clarityq.ai/automations/what-are-tasks.md): Automated, scheduled questions that deliver results on a recurring basis.
- [Creating & Scheduling Tasks](https://docs.clarityq.ai/automations/creating-and-scheduling-tasks.md): How to create, schedule, edit, and manage automated tasks.
- [Task Delivery & Notifications](https://docs.clarityq.ai/automations/task-delivery-and-notifications.md): How task results are delivered via email, Slack, and in-app.
- [Embedding ClarityQ](https://docs.clarityq.ai/integrations/embed/embedding-clarityq.md): Put ClarityQ inside your own product with an iframe. Your users ask questions of their data without leaving your app and without a ClarityQ login — your backend vouches for each one with a short-lived token.
- [Mint an embed token](https://docs.clarityq.ai/integrations/embed/mint-embed-token.md): Mint a short-lived token for one end user of your embedded analyst. Call this from your server — the API key must never reach the browser; only the returned token does. The email you send becomes the ClarityQ identity, so send only addresses your application has authenticated.
- [List conversations](https://docs.clarityq.ai/integrations/embed/list-conversations.md): List the conversations belonging to the token's user in this product — for rendering a history panel next to the embedded analyst. Authenticated with the embed token itself, not the API key. Returns a flat array in no particular order.
- [Connecting Slack](https://docs.clarityq.ai/integrations/slack/connecting-slack.md): Install the ClarityQ Slack app for your workspace so tasks, reports, and answers can flow into Slack.
- [Using ClarityQ in Slack](https://docs.clarityq.ai/integrations/slack/using-clarityq-in-slack.md): Receive task deliveries, ask questions, and manage your identity without leaving Slack.
- [MCP Connectors](https://docs.clarityq.ai/integrations/mcp/connecting-mcp-servers.md): Add and manage MCP (Model Context Protocol) connectors for your organization so ClarityQ's agent can use external tools.
- [Using Apps](https://docs.clarityq.ai/integrations/mcp/using-mcp-servers.md): Connect to the MCP apps your organization provides and turn them on in a chat so ClarityQ can use their tools.
- [User Management and Roles](https://docs.clarityq.ai/admin/user-management-and-roles.md): Invite teammates, assign roles, and control who can do what across your products.
- [Organization Settings](https://docs.clarityq.ai/admin/organization-settings.md): Org-wide configuration covering branding, SSO, the default product, and model preferences.
- [Filters](https://docs.clarityq.ai/admin/filters.md): Org-wide and table-level rules that scope every query ClarityQ runs against your warehouse.
- [Security and Compliance](https://docs.clarityq.ai/admin/security-and-compliance.md): Authentication options, access control, and how ClarityQ handles your data.
- [API Reference](https://docs.clarityq.ai/api-reference/index.md): ClarityQ public API endpoints, authenticated via API keys.
- [Ask a question](https://docs.clarityq.ai/api-reference/api/ask-a-question.md): Submit a natural-language question to the ClarityQ agent. The request is processed asynchronously; use the returned conversation_id to poll for results. The optional data_partition restricts the analyzed data to a UTC date range, like the date filter in the ClarityQ app; when omitted, the product's…
- [Get conversation status](https://docs.clarityq.ai/api-reference/api/get-conversation-status.md): Retrieve the current status of a conversation.
- [Get conversation summary](https://docs.clarityq.ai/api-reference/api/get-conversation-summary.md): Retrieve a summary of the conversation's last assistant response, including any SQL queries that were executed and a text summary.
- [Submit Feedback](https://docs.clarityq.ai/api-reference/api/submit-feedback.md): Submit or replace the rating and/or comment on the conversation's latest answer. The feedback is stored on the answer exactly like the in-app rating, so API and in-app feedback are interchangeable. The conversation must be COMPLETED. The call is idempotent: a repeat call fully replaces prior feedbac…
- [Get last completed task run summary](https://docs.clarityq.ai/api-reference/api/get-last-completed-task-run-summary.md): Retrieve the SQL results and text summary from the last completed run of a task.
- [Get Prompt Usage](https://docs.clarityq.ai/api-reference/api/get-prompt-usage.md): Return prompt usage for the organization that owns the given product as flat count buckets, always grouped by product. Use the repeatable breakdown_by parameter to control dimensions (user, origin, date); by default counts are broken down by origin, aggregated over the whole window. The API key auth…
- [Submit External Feedback](https://docs.clarityq.ai/api-reference/api/submit-external-feedback.md): Store an arbitrary evaluation/feedback JSON payload from an external system. The payload is stored as-is without validation. The optional external_id and conversation_id are sender-side identifiers kept as opaque strings for later correlation.
- [DOCUMENTATION STRUCTURE](https://docs.clarityq.ai/DOCUMENTATION_STRUCTURE.md)
- [Welcome to ClarityQ](https://docs.clarityq.ai/index.md): Learn how to set up, configure, and use ClarityQ — the AI-powered data analytics platform.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)