# TextQL Docs: Documentation

## Documentation

### Get Started

- [What is TextQL](https://docs.textql.com/core/get-started/quickstart.md): TextQL is an AI data scientist that connects to your entire data stack and answers questions in plain language.
- [Connect Your Data](https://docs.textql.com/core/get-started/connect-your-data.md): Connect Ana to a data warehouse, upload a file, or link a BI tool.
- [Example Connectors](https://docs.textql.com/core/get-started/sample-data.md): Sample data sources for exploring, demoing, and testing connector workflows.
- [Your First Chat](https://docs.textql.com/core/get-started/your-first-chat.md): A step-by-step walkthrough of your first conversation with Ana.

### How It Works

- [Threads — Chat with Ana](https://docs.textql.com/core/how-it-works/ana/overview.md): TextQL's agentic data platform, built for enterprise data scale and security.
- [Dashboards](https://docs.textql.com/core/how-it-works/dashboards.md): Turn conversations into live, interactive dashboards your team can explore
- [Citations](https://docs.textql.com/core/how-it-works/citations.md): Trace every answer back to its source
- [Subagents](https://docs.textql.com/core/how-it-works/ana/subagents.md): Let Ana delegate focused sub-tasks to child agents that work in their own context and return a distilled answer.
- [CLI](https://docs.textql.com/core/admin/cli.md): Install the refinery command-line tool, sign in, and point a coding agent at it
- [Running an Agent Loop on Sandcastles](https://docs.textql.com/core/guides/agent-loop-sandcastles.md): Connect your own agent loop to a TextQL Sandcastle — run the loop inside the sandbox with a local filesystem, or keep it in your own infra and drive the sandbox remotely.

#### Playbooks

- [Build Playbooks Directly in Threads](https://docs.textql.com/core/how-it-works/playbooks/build-from-threads.md): Agent-built playbooks
- [Overview](https://docs.textql.com/core/how-it-works/playbooks.md): Recurring agent runs
- [Slack Integration](https://docs.textql.com/core/how-it-works/playbooks/slack-integration.md): Send Playbook results to Slack channels so your teammates can read along and ask follow-up questions directly in Slack
- [Teams Integration](https://docs.textql.com/core/how-it-works/playbooks/teams-integration.md): Send Playbook results to Microsoft Teams channels so your teammates can read along and ask follow-up questions directly in Teams
- [Templates](https://docs.textql.com/core/how-it-works/playbooks/templates.md): Batch Playbook Execution with Template Variables
- [Your First Playbook](https://docs.textql.com/core/how-it-works/playbooks/your-first-playbook.md): Step-by-step guide to creating, scheduling, and deploying your first Playbook.

#### Tools

- [Overview](https://docs.textql.com/core/how-it-works/tools.md): Understanding Ana's built-in tools and capabilities
- [Text to SQL](https://docs.textql.com/core/how-it-works/tools/text-to-sql.md): Convert natural language to SQL queries
- [TQL Query](https://docs.textql.com/core/how-it-works/tools/tql-query.md): Query your semantic layer using TQL (TextQL Query Language).
- [Ana Forms](https://docs.textql.com/core/how-it-works/tools/ana-forms.md): Ana can ask for everything it needs in one structured card
- [Web Search](https://docs.textql.com/core/how-it-works/tools/web-search.md): Search the web for current information
- [Thread History Search](https://docs.textql.com/core/how-it-works/tools/thread-search.md): Search your own past threads to reuse relevant prior analysis
- [File Upload](https://docs.textql.com/core/how-it-works/tools/file-upload.md): What you can upload into a Thread or Playbook, and the size limits that apply
- [Voice Input](https://docs.textql.com/core/how-it-works/tools/voice-input.md): Dictate prompts into the chat composer instead of typing them

#### Data Apps

- [Data Apps](https://docs.textql.com/core/how-it-works/data-apps.md): Prompt Ana in chat and get a working, interactive application back
- [The ana.* Functions](https://docs.textql.com/core/how-it-works/data-apps/ana-functions.md): The built-in functions a Data App uses to read data, run compute, remember state, and ask Ana

#### Feed

- [Agents](https://docs.textql.com/core/how-it-works/feed/agents.md): Long-horizon AI agents that continuously watch your data and collaborate with other agents to find insights.
- [Build your first feed agent](https://docs.textql.com/core/how-it-works/feed/quickstart.md): Go from zero to your first agent posting insights in under five minutes.
- [Feed Overview](https://docs.textql.com/core/how-it-works/feed.md): A shared activity stream where your agents publish insights, analyses, and alerts for your team.
- [Feeds and channels](https://docs.textql.com/core/how-it-works/feed/feeds-and-channels.md): How the main Feed and channel-based sub-feeds organize posts, agents, and visibility.

##### Triggers

- [Slack triggers](https://docs.textql.com/core/how-it-works/feed/triggers/slack-triggers.md): Let people open the Slack agent picker with the /agent command.

### Set Up Your Data

- [The Connectors Page](https://docs.textql.com/core/datasources/the-connectors-page.md): Connecting external sources to TextQL

#### APIs

- [Overview](https://docs.textql.com/core/datasources/api-connectors.md): Connect external web APIs securely to TextQL
- [Anthropic API Connector](https://docs.textql.com/core/datasources/apis/anthropic.md): Call the Anthropic API as a processing step inside Ana's Python sandbox — run Claude on warehouse data at scale to summarize, classify, or extract structured fields from text columns, and chain model outputs with SQL results in a single workflow.
- [Apollo.io Connector](https://docs.textql.com/core/datasources/apis/apollo.md): Query your Apollo contacts, accounts, sequences, and engagement data directly in Ana.
- [Attio Connector](https://docs.textql.com/core/datasources/apis/attio.md): Query your Attio CRM records, lists, and workspace data directly in Ana.
- [AWS Connector](https://docs.textql.com/core/datasources/apis/aws.md): Query your AWS data in Ana to surface insights on cloud spend, resource health, and consumption trends.
- [Microsoft Azure Connector](https://docs.textql.com/core/datasources/apis/azure.md): Connect Ana to Microsoft Azure to analyze files in Blob Storage and query Azure APIs with fully managed authentication.
- [Cloudflare Connector](https://docs.textql.com/core/datasources/apis/cloudflare.md): Query your Cloudflare analytics, traffic logs, and performance data directly in Ana to surface insights on web performance, security threats, and infrastructure health.
- [Dropbox Connector](https://docs.textql.com/core/datasources/apis/dropbox.md): Search, read, and analyze files and folders in your Dropbox account or team from Ana.
- [ElevenLabs Connector](https://docs.textql.com/core/datasources/apis/elevenlabs.md): Query your ElevenLabs voices, generation history, and usage data directly in Ana.
- [Gemini Connector](https://docs.textql.com/core/datasources/apis/gemini.md): Query Google Gemini models, tuned models, and files directly in Ana.
- [GitHub Connector](https://docs.textql.com/core/datasources/apis/githubapi.md): Query your GitHub repos, pull requests, issues, and code activity in natural language and join engineering data with your warehouse for cross-source insights.
- [Google Cloud Connector](https://docs.textql.com/core/datasources/apis/googlecloud.md): Query and explore your cloud data with your warehouse in natural language.
- [Google Drive Connector](https://docs.textql.com/core/datasources/google-drive.md): Connect Google Drive to TextQL to query Google Sheets, read Google Docs, and let Ana work with your Google Suite data.
- [Grain Connector](https://docs.textql.com/core/datasources/apis/grain.md): Connect Grain to TextQL to query meeting notes, transcripts, and highlights across your team's calls.
- [HubSpot Connector](https://docs.textql.com/core/datasources/apis/hubspot.md): Query and analyze your HubSpot deals, contacts, pipelines, and ticket data directly in Ana.
- [Jira Connector](https://docs.textql.com/core/datasources/apis/jira.md): Query and explore your Jira projects, issues, and task statuses directly in TextQL.
- [Linear Connector](https://docs.textql.com/core/datasources/apis/linear.md): Query your Linear issues, projects, and team workflows directly in Ana.
- [Mercury Connector](https://docs.textql.com/core/datasources/apis/mercury.md): Query your Mercury bank accounts, transactions, and cash flow directly in Ana.
- [Notion Connector](https://docs.textql.com/core/datasources/apis/notion.md): Connect Notion to TextQL to query pages, databases, and notes across your workspace.
- [OpenAI API Connector](https://docs.textql.com/core/datasources/apis/openai.md): Run OpenAI chat completions, embeddings, and moderation alongside your warehouse data in Ana.
- [Oracle Fusion Connector](https://docs.textql.com/core/datasources/apis/oracle.md): Query and analyze your Oracle Fusion data in Ana.
- [PowerBI Connector](https://docs.textql.com/core/datasources/business-intel/powerbi-connector.md): Connecting PowerBI to TextQL
- [Pylon Connector](https://docs.textql.com/core/datasources/apis/pylon.md): Query your Pylon support issues, accounts, and customer health data directly in Ana.
- [Ramp Connector](https://docs.textql.com/core/datasources/apis/ramp.md): Query your Ramp transactions, cards, reimbursements, and spend data directly in Ana.
- [Salesforce Connector](https://docs.textql.com/core/datasources/apis/salesforce.md): Query and analyze your Salesforce accounts, opportunities, contacts, and pipeline data directly in Ana.
- [SendGrid Connector](https://docs.textql.com/core/datasources/apis/sendgrid.md): Send transactional and data-driven emails from Ana's Python sandbox — deliver reports, alerts, and personalized messages built from your warehouse data in a single workflow.
- [Slack API Connector](https://docs.textql.com/core/datasources/apis/slackapi.md): Query and analyze your team's Slack messages, channels, and engagement patterns directly through Ana.
- [Tableau Connector](https://docs.textql.com/core/datasources/business-intel/tableau-connector.md): Connecting Tableau to TextQL
- [YouTube Analytics](https://docs.textql.com/core/datasources/youtube.md): Connect your YouTube channel to Ana for video analytics and performance tracking

#### Databases

- [Amazon Aurora Connector](https://docs.textql.com/core/datasources/databases/aurora.md): Connect TextQL to your Amazon Aurora database
- [AWS Athena Connector](https://docs.textql.com/core/datasources/databases/athena.md): Connecting TextQL to Amazon Athena
- [Azure Synapse Analytics Connector](https://docs.textql.com/core/datasources/databases/azure-synapse.md): Connect TextQL to your Azure Synapse Analytics workspace
- [BigQuery Connector](https://docs.textql.com/core/datasources/databases/bigquery.md): Connecting TextQL to Google BigQuery
- [ClickHouse Connector](https://docs.textql.com/core/datasources/databases/clickhouse.md): Connecting TextQL to ClickHouse
- [Databricks Connector](https://docs.textql.com/core/datasources/databases/databricks.md): Connecting TextQL to Databricks
- [Dremio Connector](https://docs.textql.com/core/datasources/databases/dremio.md): Connecting TextQL to Dremio
- [Exasol Connector](https://docs.textql.com/core/datasources/databases/exasol.md): Connecting TextQL to Exasol
- [Firebolt Connector](https://docs.textql.com/core/datasources/databases/firebolt.md): Connecting TextQL to Firebolt
- [kdb+ Connector](https://docs.textql.com/core/datasources/databases/kdb.md): Connecting TextQL to kdb+ (kx/q)
- [MongoDB Connector](https://docs.textql.com/core/datasources/databases/mongodb.md): Query your MongoDB collections in Ana using native aggregation pipelines.
- [MySQL Connector](https://docs.textql.com/core/datasources/databases/mysql.md): Connecting TextQL to MySQL
- [Network Configuration](https://docs.textql.com/core/datasources/databases/network-configuration.md): Configure firewall rules to allow TextQL to connect to your databases
- [Per-Member Authentication](https://docs.textql.com/core/datasources/per-member-auth.md): Configure individual warehouse authentication for team members
- [PostgreSQL Connector](https://docs.textql.com/core/datasources/databases/postgresql.md): Connect TextQL to your PostgreSQL database
- [Prometheus Connector](https://docs.textql.com/core/datasources/databases/prometheus.md): Query your Prometheus metrics in Ana using native PromQL.
- [Redshift Connector](https://docs.textql.com/core/datasources/databases/redshift.md): Connecting TextQL to Amazon Redshift
- [SAP HANA Connector](https://docs.textql.com/core/datasources/databases/sap-hana.md): Connecting TextQL to SAP HANA (on-premise and HANA Cloud)
- [Snowflake Connector](https://docs.textql.com/core/datasources/databases/snowflake.md): Connecting TextQL to Snowflake
- [Supabase Connector](https://docs.textql.com/core/datasources/databases/supabase.md): Connecting TextQL to Supabase
- [Trino Connector](https://docs.textql.com/core/datasources/databases/trino.md): Connecting TextQL to Trino

#### MCP Servers

- [MCP Reference](https://docs.textql.com/core/how-it-works/mcp/reference.md): Configuration options, troubleshooting, and advanced topics
- [MCP Tools: Getting Started](https://docs.textql.com/core/how-it-works/mcp/getting-started.md): Connect Ana to external tools using the Model Context Protocol

### Integrations

- [MS Teams](https://docs.textql.com/core/integrations/teams.md): TextQL Microsoft Teams Integration
- [Slack](https://docs.textql.com/core/integrations/slack.md): TextQL integration for Slack

#### Desktop App

- [Desktop App](https://docs.textql.com/core/integrations/desktop-app.md): Install and use TextQL as an app on your Mac, Windows, or Linux computer
- [Desktop App Rollout](https://docs.textql.com/core/admin/desktop-app.md): Distribute the desktop app, point it at your server, and control who can download it

#### Embedding TextQL

- [Embedding Chat](https://docs.textql.com/core/guides/embedding-ana.md): Embed Ana in your application, use the TextQL API, and manage authentication for embedded deployments.
- [Embedding Dashboards](https://docs.textql.com/core/guides/embedding-dashboards.md): Publish a dashboard into another application with a revocable embed link
- [Embedding Data Apps](https://docs.textql.com/core/guides/embedding-data-apps.md): Embed a Data App in your own product, with per-user row-level security (RLS)

### Ontology

- [Skills](https://docs.textql.com/core/ontology/skills.md): Reusable instruction sets stored in your Ontology that Ana pulls into a chat on demand — invoked by name with a slash command, or selected by Ana when the task calls for one.
- [Role & Access](https://docs.textql.com/core/ontology/ontology-rbac.md): Control which roles can read or edit each folder in your Ontology.
- [What is Ontology?](https://docs.textql.com/core/ontology/overview.md): A unified semantic layer for your business logic — metric definitions, entity relationships, and data conventions that give Ana consistent, precise knowledge of your data model.

#### Build Your Ontology

- [Build Your Ontology: Quickstart](https://docs.textql.com/core/ontology/build-your-ontology.md): How to populate, configure, and manage your ontology — from GitHub sync to objects, metrics, and Thread-driven updates.
- [.tql Manual](https://docs.textql.com/core/ontology/tql-reference.md): A practical reference for customer admins, power users, internal developers, and Ana AI.

### Get Better Results

- [How Ana Thinks](https://docs.textql.com/core/get-better-results/how-ana-thinks.md): Understanding how Ana processes questions will help you get better answers faster and know when to give her more guidance.
- [Interactive HTML Reports](https://docs.textql.com/core/guides/interactive-html-reports.md): Use a prompt to generate standalone HTML dashboards from your database
- [Validating and Improving Ana's Answers](https://docs.textql.com/core/get-better-results/validating-answers.md): How to read Ana's work critically, what to do when something looks off, and how to tell whether the problem is the prompt, the context, or the data.
- [Writing Better Playbook Prompts](https://docs.textql.com/core/get-better-results/constructing-better-playbooks.md): How to write Playbook prompts that produce consistent, reliable results every time they run.
- [Writing Better Prompts](https://docs.textql.com/core/get-better-results/writing-better-prompts.md): Practical habits for getting faster, more accurate answers from Ana.

### Admin & Security

- [Audit Log](https://docs.textql.com/core/admin/audit-log.md): Monitor security and administrative activity across your organization
- [Deployment Configuration](https://docs.textql.com/core/admin/deployment-config.md): Helm values and settings for self-hosted TextQL deployments
- [Model Management](https://docs.textql.com/core/admin/models.md): Configure which AI models are available in your organization, set defaults, and control per-role access
- [Role-Based Access Control (RBAC)](https://docs.textql.com/core/admin/rbac.md): Manage who can access what in TextQL using roles and permissions
- [SCIM Provisioning](https://docs.textql.com/core/admin/scim.md): Automate user and group lifecycle management with SCIM 2.0
- [TextQL Pricing and Consumption Table](https://docs.textql.com/core/admin/pricing.md): Understand TextQL’s Pricing

#### Settings

- [Settings Overview](https://docs.textql.com/core/admin/settings.md): A guide to every section in the TextQL Settings panel
- [API Keys](https://docs.textql.com/core/admin/api-keys.md): Issue, scope, and revoke keys for programmatic access to TextQL

#### Compliance

- [Network Configuration](https://docs.textql.com/core/admin/compliance/network-configuration.md): Configure proxies, firewalls, and SSL inspection so your network can reach TextQL
- [Network Integration Options](https://docs.textql.com/core/admin/compliance/network-integration.md): How TextQL connects to your data sources — choose the model that fits your network and compliance requirements.
- [TextQL Deployment Types](https://docs.textql.com/core/admin/compliance/deployment-types.md)
- [TextQL Inference Options](https://docs.textql.com/core/admin/compliance/inference-options.md)
- [TextQL Security and Data Governance Whitepaper](https://docs.textql.com/core/admin/compliance/security.md)
- [TextQL-Agent (web requests)](https://docs.textql.com/bot.md): Identify and opt out of web requests made by TextQL agent sandboxes.

#### Console

- [Usage](https://docs.textql.com/core/admin/console/usage.md): How compute usage is attributed
- [Organization Limits](https://docs.textql.com/core/admin/limits.md): Understanding organization specifications and limits in TextQL

#### Observability

- [Audit Logs and Metrics via OpenTelemetry](https://docs.textql.com/core/admin/observability-export.md): Stream audit logs and product metrics directly into the observability platforms you already operate — Datadog, Splunk, Grafana, Prometheus, or S3.
- [Observability](https://docs.textql.com/core/admin/observability.md): Retrospectively review thread quality with signals, identify recurring issues, celebrate what works, and take action to improve future analysis across your organization.

#### Single Sign-On (SSO)

- [Okta](https://docs.textql.com/core/admin/sso-okta.md): Step-by-step guide to configure Okta OIDC for TextQL
- [Single Sign-On (SSO)](https://docs.textql.com/core/admin/sso.md): Configure enterprise SSO with OIDC for your organization

#### Usage & Billing APIs

- [Get Usage via API](https://docs.textql.com/core/admin/usage-api.md): Retrieve ACU usage records for your organization programmatically via the TextQL Billing Usage API.
- [BYOK Token Usage](https://docs.textql.com/core/admin/token-usage-api.md): Retrieve raw LLM token usage by organization, member, and model programmatically. BYOK deployments only.

### FAQ

- [Chat Error Messages (Advanced)](https://docs.textql.com/core/how-it-works/chat-errors.md): What to do when Ana shows you an error statement.
- [Frequently Asked Questions](https://docs.textql.com/core/how-it-works/faq.md): Common issues and how to resolve them.
- [Get Help](https://docs.textql.com/core/get-started/customer-support.md): Need help with TextQL? Here's how to get support.
- [Send Us a HAR File](https://docs.textql.com/core/get-started/har-file.md): How to record and safely share a network trace so we can debug loading, timeout, and network errors.

### Legacy Features

#### Getting Started with Context

- [Context Scoping](https://docs.textql.com/core/archived-ontology/context-library/context-scoping.md): Understand how to apply context at different levels: organization, role, and connector
- [Dynamic Context Loading](https://docs.textql.com/core/archived-ontology/context-library/github-dynamic-loading.md): How Ana navigates your GitHub repository to fetch only the files relevant to each question — not a static snapshot, but a live read at query time.
- [GitHub Integration for Context](https://docs.textql.com/core/archived-ontology/context-library/github-integration.md): Connect Ana to a GitHub repository to load context dynamically and version-control context updates through pull requests.
- [Using the Context Editor](https://docs.textql.com/core/archived-ontology/context-library/context-editor.md): Learn how to create, edit, and manage context documents using TextQL's product-native context editor
- [Version-Controlled Context Writing](https://docs.textql.com/core/archived-ontology/context-library/github-version-control.md): How Ana proposes context changes via pull requests, and why keeping humans in the review loop matters.
- [What is Context?](https://docs.textql.com/core/archived-ontology/context-library/what-is-context.md): Learn how context helps Ana understand your organization and provide more relevant, accurate responses

#### Getting Started with Ontology

- [What is Ontology?](https://docs.textql.com/core/archived-ontology/ontology-guide/what-is-ontology.md): Learn what ontology is and how it helps ensure consistent, accurate answers across your organization
- [Building Your First Ontology](https://docs.textql.com/core/archived-ontology/ontology-guide/building-your-first-ontology.md): Step-by-step guide to manually creating objects, attributes, links, and metrics in your ontology
- [Core Concepts Explained](https://docs.textql.com/core/archived-ontology/ontology-guide/core-concepts.md): Understanding the four building blocks of ontology: Objects, Attributes, Links, and Metrics
- [Quick Start Ontology](https://docs.textql.com/core/archived-ontology/ontology-guide/quick-start-ontology.md): Build your ontology faster by having Ana create and modify it directly through chat
- [Sample Conglomerate Ontology](https://docs.textql.com/core/archived-ontology/ontology-guide/sample-conglomerate-ontology.md): TextQL's Sample Conglomerate Ontology
- [Why Use Ontology?](https://docs.textql.com/core/archived-ontology/ontology-guide/why-use-ontology.md): Discover the benefits of ontology including consistency, speed, and security, plus when to use it versus Text-to-SQL

#### Ontology

- [Ontology Overview](https://docs.textql.com/core/archived-ontology/ontology-how-it-works/overview.md)
- [BI Dashboards](https://docs.textql.com/core/archived-ontology/ontology-how-it-works/dashboards.md): Understanding BI dashboard support in TextQL
- [Files and Spreadsheets](https://docs.textql.com/core/archived-ontology/ontology-how-it-works/files.md): Understanding file support in the TextQL ontology
- [Known Missing Features](https://docs.textql.com/core/archived-ontology/ontology-how-it-works/missing.md): Features planned for future ontology development
- [Metrics](https://docs.textql.com/core/archived-ontology/ontology-how-it-works/metrics.md): Mark attributes as measures or dimensions to optimize query performance
- [Object Links](https://docs.textql.com/core/archived-ontology/ontology-how-it-works/links.md): Connect objects with relationships in your ontology
- [Objects](https://docs.textql.com/core/archived-ontology/ontology-how-it-works/objects.md): Define business entities in your semantic layer
- [Queries](https://docs.textql.com/core/archived-ontology/ontology-how-it-works/queries.md): How the ontology is used to make AI-generated queries
- [TQL Language Reference](https://docs.textql.com/core/archived-ontology/ontology-how-it-works/tql-reference.md): The ontology query language for building reusable, parameterized SQL templates
- [Why Ontology? (Advanced)](https://docs.textql.com/core/archived-ontology/ontology-how-it-works/why.md): Technical deep dive into the benefits of using ontologies