Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clarityq.ai/llms.txt

Use this file to discover all available pages before exploring further.

ClarityQ lets anyone in your organization ask data questions in plain English and get accurate answers, insights, and visualizations. These docs cover everything from connecting your data warehouse to building the Context Layer that makes it all work.

​
Get Started

What is ClarityQ?

Learn what ClarityQ does and how it works.

Connect Your Data Warehouse

Set up your first data warehouse connection.

Build Your Context Layer

Teach ClarityQ your business context.

Your First Chat

Ask your first question and get answers.

​
Explore

Context Layer

Table catalog, event catalog, semantic catalog, memory, and skills.

Ask Anything

Ask data questions in natural language.

Automations

Schedule recurring questions and reports.

​
API Reference

The ClarityQ API allows you to interact with ClarityQ programmatically using API keys. All endpoints require authentication via the X-API-Key header. Base URL: https://api.clarityq.ai

​
Endpoints

Ask a Question

Submit a natural-language question to the ClarityQ agent.

Get Conversation Status

Poll for the status of an ongoing conversation.

Get Conversation Summary

Retrieve the summary of a completed conversation.

Get Last Completed Task Run Summary

Get the summary of the last completed task run.

​
Support

Need help? Reach out to us at support@clarityq.ai.