# TextQL Docs

## Docs

- [Create API Access Key](https://docs.textql.com/api-reference/api-keys/api-keys/create-api-access-key.md): Create a new API access key for an external API provider
- [Delete API Access Key](https://docs.textql.com/api-reference/api-keys/api-keys/delete-api-access-key.md): Delete an API access key by ID
- [List API Access Keys](https://docs.textql.com/api-reference/api-keys/api-keys/list-api-access-keys.md): List all API access keys for your organization
- [List API Providers](https://docs.textql.com/api-reference/api-keys/api-keys/list-api-providers.md): List all supported API providers and their configuration templates
- [Update API Access Key](https://docs.textql.com/api-reference/api-keys/api-keys/update-api-access-key.md): Update an existing API access key
- [Cancel Chat](https://docs.textql.com/api-reference/chat/chat/cancel-a-running-chat.md): Cancel a running chat query
- [Create Chat](https://docs.textql.com/api-reference/chat/chat/create.md): Create a new chat
- [Get Chat](https://docs.textql.com/api-reference/chat/chat/get-chat-details.md): Retrieve details of a specific chat by ID
- [Stream Chat](https://docs.textql.com/api-reference/chat/chat/stream.md): Stream chat responses in real-time using Connect-RPC
- [Client SDKs](https://docs.textql.com/api-reference/client-sdks.md): Official TextQL SDKs for Python and JavaScript/TypeScript
- [List Connectors](https://docs.textql.com/api-reference/connectors/connectors/list-all-connectors.md): Retrieve all connectors for your organization
- [Introduction](https://docs.textql.com/api-reference/introduction.md): Welcome to the TextQL Platform API
- [Execute Code](https://docs.textql.com/api-reference/platform/sandbox/execute.md): Execute Python code in a running sandbox
- [Load Connector Data](https://docs.textql.com/api-reference/platform/sandbox/load-connector-data.md): Execute a SQL query against a connector and load the results into the sandbox as a pandas DataFrame
- [Start Sandbox](https://docs.textql.com/api-reference/platform/sandbox/start.md): Start a new Python sandbox environment
- [Get Sandbox Status](https://docs.textql.com/api-reference/platform/sandbox/status.md): Get the current status of a sandbox, including loaded dataframes and memory usage
- [Stop Sandbox](https://docs.textql.com/api-reference/platform/sandbox/stop.md): Stop and destroy a running sandbox
- [Upload File](https://docs.textql.com/api-reference/platform/sandbox/upload.md): Upload a file into the sandbox filesystem
- [Create Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/create-a-new-playbook.md): Create a new playbook
- [Delete Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/delete-a-playbook.md): Delete a playbook by playbookId
- [Deploy Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/deploy-a-playbook.md): Deploy a playbook by playbookId
- [Get Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/get-a-playbook-by-id.md): Get a playbook by playbookId
- [List Playbooks](https://docs.textql.com/api-reference/playbooks/playbooks/list-playbooks.md): Get all playbooks
- [Run Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/run-a-playbook.md): Execute a playbook and return the generated report
- [Update Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/update-a-playbook.md): Update a playbook
- [Audit Log](https://docs.textql.com/core/admin/audit-log.md): Monitor security and administrative activity across your organization
- [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)
- [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 Security and Data Governance Whitepaper](https://docs.textql.com/core/admin/compliance/security.md)
- [Deployment Configuration](https://docs.textql.com/core/admin/deployment-config.md): Helm values and settings for self-hosted TextQL deployments
- [Organization Limits](https://docs.textql.com/core/admin/limits.md): Understanding organization specifications and limits in TextQL
- [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
- [TextQL Pricing and Consumption Table](https://docs.textql.com/core/admin/pricing.md): Understand TextQL’s Pricing
- [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
- [Single Sign-On (SSO)](https://docs.textql.com/core/admin/sso.md): Configure enterprise SSO with OIDC for your organization
- [Okta](https://docs.textql.com/core/admin/sso-okta.md): Step-by-step guide to configure Okta OIDC for TextQL
- [Usage API](https://docs.textql.com/core/admin/usage-api.md): Retrieve ACU usage records for your organization programmatically via the TextQL Billing Usage API.
- [API Connectors](https://docs.textql.com/core/datasources/api-connectors.md): Connect external web APIs securely to TextQL
- [PowerBI Connector](https://docs.textql.com/core/datasources/business-intel/powerbi-connector.md): Connecting PowerBI to TextQL
- [Tableau Connector](https://docs.textql.com/core/datasources/business-intel/tableau-connector.md): Connecting Tableau to TextQL
- [AWS Athena Connector](https://docs.textql.com/core/datasources/databases/athena.md): Connecting TextQL to Amazon Athena
- [Amazon Aurora Connector](https://docs.textql.com/core/datasources/databases/aurora.md): Connect TextQL to your Amazon Aurora database
- [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
- [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
- [PostgreSQL Connector](https://docs.textql.com/core/datasources/databases/postgresql.md): Connect TextQL to your PostgreSQL database
- [Redshift Connector](https://docs.textql.com/core/datasources/databases/redshift.md): Connecting TextQL to Amazon Redshift
- [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
- [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.
- [Per-Member Authentication](https://docs.textql.com/core/datasources/per-member-auth.md): Configure individual warehouse authentication for team members
- [Salesforce Connector](https://docs.textql.com/core/datasources/salesforce/salesforce.md): Connecting Salesforce to TextQL
- [The Connectors Page](https://docs.textql.com/core/datasources/the-connectors-page.md): Connecting external sources to TextQL
- [YouTube Analytics](https://docs.textql.com/core/datasources/youtube.md): Connect your YouTube channel to Ana for video analytics and performance tracking
- [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.
- [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.
- [Setting Up Context for Best Results](https://docs.textql.com/core/get-better-results/setting-up-context.md): A guide for admins and data champions on configuring context so Ana knows your business rules, metric definitions, and data conventions.
- [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 Prompts](https://docs.textql.com/core/get-better-results/writing-better-prompts.md): Practical habits for getting faster, more accurate answers from Ana.
- [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.
- [Get Help](https://docs.textql.com/core/get-started/customer-support.md): Need help with TextQL? Here's how to get support.
- [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.
- [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.
- [Using the Context Editor](https://docs.textql.com/core/guides/context/context-editor.md): Learn how to create, edit, and manage context documents using TextQL's product-native context editor
- [Context Scoping](https://docs.textql.com/core/guides/context/context-scoping.md): Understand how to apply context at different levels: organization, role, and connector
- [Dynamic Context Loading](https://docs.textql.com/core/guides/context/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/guides/context/github-integration.md): Connect Ana to a GitHub repository to load context dynamically and version-control context updates through pull requests.
- [Version-Controlled Context Writing](https://docs.textql.com/core/guides/context/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/guides/context/what-is-context.md): Learn how context helps Ana understand your organization and provide more relevant, accurate responses
- [Embedding Ana](https://docs.textql.com/core/guides/embedding-ana.md): Embed Ana in your application, use the TextQL API, and manage authentication for embedded deployments.
- [Interactive HTML Reports](https://docs.textql.com/core/guides/interactive-html-reports.md): Use a prompt to generate standalone HTML dashboards from your database
- [Building Your First Ontology](https://docs.textql.com/core/guides/ontology/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/guides/ontology/core-concepts.md): Understanding the four building blocks of ontology: Objects, Attributes, Links, and Metrics
- [Quick Start Ontology](https://docs.textql.com/core/guides/ontology/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/guides/ontology/sample-conglomerate-ontology.md): TextQL's Sample Conglomerate Ontology
- [What is Ontology?](https://docs.textql.com/core/guides/ontology/what-is-ontology.md): Learn what ontology is and how it helps ensure consistent, accurate answers across your organization
- [Why Use Ontology?](https://docs.textql.com/core/guides/ontology/why-use-ontology.md): Discover the benefits of ontology including consistency, speed, and security, plus when to use it versus Text-to-SQL
- [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.
- [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.
- [Dashboards](https://docs.textql.com/core/how-it-works/dashboards.md): Turn conversations into live, interactive dashboards your team can explore
- [Frequently Asked Questions](https://docs.textql.com/core/how-it-works/faq.md): Common issues and how to resolve them.
- [Feed](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.
- [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
- [MCP Reference](https://docs.textql.com/core/how-it-works/mcp/reference.md): Configuration options, troubleshooting, and advanced topics
- [BI Dashboards](https://docs.textql.com/core/how-it-works/ontology/dashboards.md): Understanding BI dashboard support in TextQL
- [Files and Spreadsheets](https://docs.textql.com/core/how-it-works/ontology/files.md): Understanding file support in the TextQL ontology
- [Object Links](https://docs.textql.com/core/how-it-works/ontology/links.md): Connect objects with relationships in your ontology
- [Metrics](https://docs.textql.com/core/how-it-works/ontology/metrics.md): Mark attributes as measures or dimensions to optimize query performance
- [Known Missing Features](https://docs.textql.com/core/how-it-works/ontology/missing.md): Features planned for future ontology development
- [Objects](https://docs.textql.com/core/how-it-works/ontology/objects.md): Define business entities in your semantic layer
- [Ontology Overview](https://docs.textql.com/core/how-it-works/ontology/overview.md)
- [Queries](https://docs.textql.com/core/how-it-works/ontology/queries.md): How the ontology is used to make AI-generated queries
- [TQL Language Reference](https://docs.textql.com/core/how-it-works/ontology/tql-reference.md): The ontology query language for building reusable, parameterized SQL templates
- [Why Ontology? (Advanced)](https://docs.textql.com/core/how-it-works/ontology/why.md): Technical deep dive into the benefits of using ontologies
- [Overview](https://docs.textql.com/core/how-it-works/playbooks.md): Recurring agent runs
- [Build Playbooks Directly in Threads](https://docs.textql.com/core/how-it-works/playbooks/build-from-threads.md): Agent-built playbooks
- [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
- [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.
- [Templates](https://docs.textql.com/core/how-it-works/templates.md): Batch Playbook Execution with Template Variables
- [Tools](https://docs.textql.com/core/how-it-works/tools.md): Understanding Ana's capabilities and settings
- [Ontology](https://docs.textql.com/core/how-it-works/tools/ontology.md): Query data using your semantic layer
- [Ontology Editing](https://docs.textql.com/core/how-it-works/tools/ontology-editing.md): Let Ana modify your semantic layer
- [Python](https://docs.textql.com/core/how-it-works/tools/python.md): Visualize and analyze your data
- [Text to SQL](https://docs.textql.com/core/how-it-works/tools/text-to-sql.md): Convert natural language to SQL queries
- [Web Search](https://docs.textql.com/core/how-it-works/tools/web-search.md): Search the web for current information
- [Slack](https://docs.textql.com/core/integrations/slack.md): TextQL integration for Slack
- [Changelog](https://docs.textql.com/helm-charts/changelog.md): Release history for the TextQL Helm chart
- [Installation](https://docs.textql.com/helm-charts/installation.md): Install the TextQL Helm chart

## OpenAPI Specs

- [playbooks.openapi](https://docs.textql.com/api-reference/platform/playbooks.openapi.yaml)
- [chat.openapi](https://docs.textql.com/api-reference/platform/chat.openapi.yaml)
- [connectors.openapi](https://docs.textql.com/api-reference/platform/connectors.openapi.yaml)
- [sandbox.openapi](https://docs.textql.com/api-reference/platform/sandbox.openapi.yaml)
- [api_access_key.openapi](https://docs.textql.com/api-reference/platform/api_access_key.openapi.yaml)
- [openapi](https://docs.textql.com/api-reference/openapi.json)