# TextQL Docs - [Documentation (150 pages)](https://docs.textql.com/_llms/documentation.md): Documentation for Documentation. - [Workshops (101 pages)](https://docs.textql.com/_llms/workshops.md): Documentation for Workshops. ## v1 API (deprecated) ### Getting Started - [Introduction](https://docs.textql.com/api-reference/introduction.md): Welcome to the TextQL Platform API ### Chat - [List Chats](https://docs.textql.com/api-reference/chat/chat/list-chats.md): List chats with optional filtering and pagination - [Create Chat](https://docs.textql.com/api-reference/chat/chat/create.md): Create a new chat - [Stream Chat](https://docs.textql.com/api-reference/chat/chat/stream.md): Stream chat responses in real-time using Connect-RPC - [Get Chat](https://docs.textql.com/api-reference/chat/chat/get-chat-details.md): Retrieve details of a specific chat by ID - [Cancel Chat](https://docs.textql.com/api-reference/chat/chat/cancel-a-running-chat.md): Cancel a running chat query ### Playbooks - [List Playbooks](https://docs.textql.com/api-reference/playbooks/playbooks/list-playbooks.md): Get all playbooks - [Create Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/create-a-new-playbook.md): Create a new playbook - [Get Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/get-a-playbook-by-id.md): Get a playbook by playbookId - [Update Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/update-a-playbook.md): Update a playbook - [Run Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/run-a-playbook.md): Execute a playbook and return the generated report - [Deploy Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/deploy-a-playbook.md): Deploy a playbook by playbookId - [Delete Playbook](https://docs.textql.com/api-reference/playbooks/playbooks/delete-a-playbook.md): Delete a playbook by playbookId ### Agents - [Trigger Agent Webhook](https://docs.textql.com/api-reference/agents/webhooks/trigger-agent-webhook.md): Trigger an agent run with a JSON webhook payload ### Connectors - [List Connectors](https://docs.textql.com/api-reference/connectors/connectors/list-all-connectors.md): Retrieve all connectors for your organization ### Sandbox - [Start Sandbox](https://docs.textql.com/api-reference/platform/sandbox/start.md): Start a new Python sandbox environment - [Execute Code](https://docs.textql.com/api-reference/platform/sandbox/execute.md): Execute Python code in a running sandbox - [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 - [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 - [Upload File](https://docs.textql.com/api-reference/platform/sandbox/upload.md): Upload a file into the sandbox filesystem ### API Keys - [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 - [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 - [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 - [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 Providers](https://docs.textql.com/api-reference/api-keys/api-keys/list-api-providers.md): List all supported API providers and their configuration templates ## v2 API ### Getting Started - [v2 API Introduction](https://docs.textql.com/api-reference/v2/introduction.md): Getting started with the TextQL v2 REST API ### API Keys - [Create API Key](https://docs.textql.com/api-reference/v2/api-keys/create-api-key.md): Mint a role-scoped platform API key, optionally carrying client metadata for row-level security - [List API Keys](https://docs.textql.com/api-reference/v2/api-keys/list-api-keys.md): List platform API keys visible to the caller - [Rotate API Key](https://docs.textql.com/api-reference/v2/api-keys/rotate-api-key.md): Revoke a key and mint a replacement with the same scope - [Revoke API Key](https://docs.textql.com/api-reference/v2/api-keys/revoke-api-key.md): Revoke a platform API key by id ### Members - [List Members](https://docs.textql.com/api-reference/v2/members/list-members.md): List the members of your organization with their assigned roles - [Invite Member](https://docs.textql.com/api-reference/v2/members/invite-member.md): Invite a new member to your organization by email - [Remove Member](https://docs.textql.com/api-reference/v2/members/delete-member.md): Remove a member from your organization - [Get Member Roles](https://docs.textql.com/api-reference/v2/members/get-member-roles.md): List the RBAC roles assigned to a member - [Assign Role to Member](https://docs.textql.com/api-reference/v2/members/assign-member-role.md): Assign an RBAC role to a member - [Remove Role from Member](https://docs.textql.com/api-reference/v2/members/remove-member-role.md): Remove an RBAC role from a member ### Roles - [List Roles](https://docs.textql.com/api-reference/v2/roles/list-roles.md): List the RBAC roles defined in your organization - [Create Role](https://docs.textql.com/api-reference/v2/roles/create-role.md): Create a custom RBAC role in your organization - [Update Role](https://docs.textql.com/api-reference/v2/roles/update-role.md): Update a role's name, description, or model configuration ### Chat - [List Chats](https://docs.textql.com/api-reference/v2/chat/list-chats.md): List chats with optional search and pagination - [Create Chat](https://docs.textql.com/api-reference/v2/chat/create-chat.md): Send a question and receive a synchronous response - [Stream Chat](https://docs.textql.com/api-reference/v2/chat/stream-chat.md): Send a question and receive a streaming SSE response - [Get Chat](https://docs.textql.com/api-reference/v2/chat/get-chat.md): Retrieve a chat by ID with messages and assets - [Get Chat Cells](https://docs.textql.com/api-reference/v2/chat/get-chat-cells.md): Retrieve a chat's per-step execution detail: messages, generated SQL and Python, outputs, and assets - [Get Chat Cell](https://docs.textql.com/api-reference/v2/chat/get-chat-cell.md): Retrieve a single cell from a chat by ID - [Cancel Stream](https://docs.textql.com/api-reference/v2/chat/cancel-stream.md): Cancel a running chat stream ### Connectors - [List Connectors](https://docs.textql.com/api-reference/v2/connectors/list-connectors.md): List all available data connectors - [List Connector Types](https://docs.textql.com/api-reference/v2/connectors/list-connector-types.md): Discover supported connector types and the fields each requires - [Create Connector](https://docs.textql.com/api-reference/v2/connectors/create-connector.md): Create a new data connector - [Test Connector](https://docs.textql.com/api-reference/v2/connectors/test-connector.md): Test a connector configuration without saving it - [Update Connector](https://docs.textql.com/api-reference/v2/connectors/update-connector.md): Update an existing data connector - [Delete Connector](https://docs.textql.com/api-reference/v2/connectors/delete-connector.md): Delete a connector by id - [Get Connector Access](https://docs.textql.com/api-reference/v2/connectors/get-connector-access.md): Get a connector's visibility and access grants - [Update Connector Access](https://docs.textql.com/api-reference/v2/connectors/update-connector-access.md): Replace a connector's visibility and access grants ### Playbooks - [List Playbooks](https://docs.textql.com/api-reference/v2/playbooks/list-playbooks.md): List playbooks with optional filtering and pagination - [Create Playbook](https://docs.textql.com/api-reference/v2/playbooks/create-playbook.md): Create a new empty playbook - [Get Playbook](https://docs.textql.com/api-reference/v2/playbooks/get-playbook.md): Retrieve a playbook by ID with its reports - [Update Playbook](https://docs.textql.com/api-reference/v2/playbooks/update-playbook.md): Update a playbook's configuration - [Run Playbook](https://docs.textql.com/api-reference/v2/playbooks/run-playbook.md): Execute a playbook and return the generated report - [Deploy Playbook](https://docs.textql.com/api-reference/v2/playbooks/deploy-playbook.md): Deploy a playbook to make it active - [Delete Playbook](https://docs.textql.com/api-reference/v2/playbooks/delete-playbook.md): Delete a playbook by ID ### Dashboards - [Create Dashboard](https://docs.textql.com/api-reference/v2/dashboards/create-dashboard.md): Ask Ana to build a dashboard in a chat session - [List Chats with Dashboards](https://docs.textql.com/api-reference/v2/dashboards/list-dashboards.md): List chats with optional search and pagination - [Get Dashboard](https://docs.textql.com/api-reference/v2/dashboards/get-dashboard.md): Retrieve a chat by ID with messages and assets, including any dashboard output - [Stream Dashboard](https://docs.textql.com/api-reference/v2/dashboards/stream-dashboard.md): Ask Ana to build a dashboard and receive a streaming SSE response as it's created - [Cancel Dashboard Stream](https://docs.textql.com/api-reference/v2/dashboards/cancel-dashboard.md): Cancel a running dashboard creation stream ### Sandcastles - [List Sandcastles](https://docs.textql.com/api-reference/v2/sandbox/list-sandboxes.md): List sandboxes with status filtering and cursor-based pagination - [Start Sandcastle](https://docs.textql.com/api-reference/v2/sandbox/start-sandbox.md): Start a new Python sandcastle, or restart a specific one - [Get Sandcastle Status](https://docs.textql.com/api-reference/v2/sandbox/get-sandbox-status.md): Get the current status of a sandbox - [List Executions](https://docs.textql.com/api-reference/v2/sandbox/list-executions.md): List a sandbox's recorded executions (Python, bash, SQL, TQL) with cursor-based pagination - [Stop Sandcastle](https://docs.textql.com/api-reference/v2/sandbox/stop-sandbox.md): Stop and destroy a running sandbox - [Execute Code](https://docs.textql.com/api-reference/v2/sandbox/execute-code.md): Execute Python code in a sandbox - [Load Connector Data](https://docs.textql.com/api-reference/v2/sandbox/load-connector-data.md): Load data from a connector into a sandbox dataframe - [Upload File](https://docs.textql.com/api-reference/v2/sandbox/upload-file.md): Upload a file to a sandbox environment - [Diff Ontology (Dry Run)](https://docs.textql.com/api-reference/v2/sandbox/diff-ontology.md): Report pending changes in the sandcastle's Ontology mount without authoring a change. - [Create Ontology Change (Writeback)](https://docs.textql.com/api-reference/v2/sandbox/create-ontology-change.md): Persist a sandcastle's edits to /sandbox/files/library back to the org's Ontology as a reviewable change. ### Changes - [List Changes](https://docs.textql.com/api-reference/v2/changes/list-changes.md): List the organization's Ontology changes, scoped to your OWNERS read access. - [Get Change](https://docs.textql.com/api-reference/v2/changes/get-change.md): Fetch a single Ontology change with its diffs and your capabilities. - [Approve Change](https://docs.textql.com/api-reference/v2/changes/approve-change.md): Record your approval and merge the change once the folder's approval rule is satisfied. - [Deny Change](https://docs.textql.com/api-reference/v2/changes/deny-change.md): Mark an Ontology change denied. The author can deny their own change. - [Restore Change](https://docs.textql.com/api-reference/v2/changes/restore-change.md): Reopen a denied Ontology change back to open for review. - [v3 API (SDK) (439 pages)](https://docs.textql.com/_llms/v3-api-sdk.md): Documentation for v3 API (SDK). ## MCP Reference ### Ana as an MCP Server - [Ana as an MCP Server](https://docs.textql.com/core/how-it-works/mcp/ana-as-mcp-server.md): Connect Ana to Cursor, Claude, ChatGPT, Copilot, and any MCP-compatible client. Ask data questions directly from your AI assistant — no context switching required. - [Connecting a Client](https://docs.textql.com/core/how-it-works/mcp/client-setup.md): Add Ana as an MCP server in Claude, Cursor, Windsurf, ChatGPT, Copilot, or Claude Code, and authorize once over OAuth. - [Tool Groups & Modes](https://docs.textql.com/core/how-it-works/mcp/tool-groups.md): Scope which of Ana's tools a connection exposes, and let your assistant load tools on demand. - [Managing Access](https://docs.textql.com/core/how-it-works/mcp/managing-access.md): Review and revoke authorized MCP clients as a user or an organization admin. ## Helm Charts ### Helm Charts - [Installation](https://docs.textql.com/helm-charts/installation.md): Install the TextQL Helm chart ## Changelog ### Changelog - [Product updates](https://docs.textql.com/product/changelog.md): New features and improvements across TextQL - [Self-hosting releases](https://docs.textql.com/helm-charts/changelog.md): Release history for the TextQL Helm chart ## OpenAPI Specs - [textql-api-with-code-samples](/api-reference/speakeasy/textql-api-with-code-samples.yaml) - [agents.openapi](/api-reference/platform/agents.openapi.yaml) - [api_access_key.openapi](/api-reference/platform/api_access_key.openapi.yaml) - [chat.openapi](/api-reference/platform/chat.openapi.yaml) - [connectors.openapi](/api-reference/platform/connectors.openapi.yaml) - [playbooks.openapi](/api-reference/platform/playbooks.openapi.yaml) - [sandbox.openapi](/api-reference/platform/sandbox.openapi.yaml) - [v2.openapi](/api-reference/platform/v2.openapi.yaml) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Documentation (150 pages)](https://docs.textql.com/_llms/documentation.md): Documentation for Documentation. - [Workshops (101 pages)](https://docs.textql.com/_llms/workshops.md): Documentation for Workshops. - [v3 API (SDK) (439 pages)](https://docs.textql.com/_llms/v3-api-sdk.md): Documentation for v3 API (SDK). This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.