Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.textql.com/llms.txt

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

v2 API is now available. The v2 API uses standard REST conventions (proper HTTP methods, path parameters, plain JSON) instead of Connect-RPC. See the v2 API Introduction to get started. The examples on this page use v1.

​
Overview

The TextQL Platform API provides programmatic access to TextQL’s core functionality, enabling you to:
  • Execute Chats: Send and Stream chat queries
  • Manage Playbooks: Create, update, deploy, and delete automated playbooks
  • Trigger Agents: Start agent runs from external systems using webhooks
  • List Connectors: Access your configured data sources
  • Manage API Keys: Create, update, and delete outbound API access keys for external providers
The following tools are unavailable via the API:
  • Context Editor - Organization context editing
  • Ontology Editor - Ontology editing
  • Streamlit - Streamlit execution
(They are still available via app.textql.com)

​
Where to get API Key

You can get your API key at Settings → Developers → API Keys. Click + Create API Key to generate one. You must be an admin to create API keys.

​
Base URL

All API requests should be made to: 
https://app.textql.com/v1

​
Authentication

All API requests require authentication using a Bearer token: 
curl -X POST "https://app.textql.com/v1/chat" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question": "What is the color of the sky?"}'