Skip to main content

​
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
  • List Connectors: Access your configured data sources
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 if you are an admin in: https://app.textql.com/settings -> Configuration -> 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?"}'