TextQL

TextQL Chat Service API

The ChatService API from TextQL — 38 operation(s) for chatservice.

GitHub OpenAPI

Operations 38

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /textql.rpc.public.chat.ChatService/ApproveContextPromptChange Approve a proposed context prompt change · ApproveContextPromptChange #
Ask an LLM
“Can I accept the context prompt edit the agent suggested in a chat, with my own tweaks?”
“What happens when I approve a context prompt change proposed inside a TextQL chat cell?”
Tell an agent
Approve the context prompt change in cell {cell} using this edited context: {edited_context}.
Accept the agent's suggested context update on cell {cell} with text {edited_context}.
POST /textql.rpc.public.chat.ChatService/ApproveOntologyChange Approve a proposed ontology change · ApproveOntologyChange #
Ask an LLM
“How do I accept an ontology change the agent proposed during a chat?”
“Can I sign off on the semantic model edit suggested in a chat cell?”
Tell an agent
Approve the ontology change proposed in cell {cell}.
Accept the agent's ontology edit from chat cell {cell}.
POST /textql.rpc.public.chat.ChatService/AttachAgentToChat Attach an agent to a chat · AttachAgentToChat #
Ask an LLM
“Can I bring one of my saved agents into an existing chat conversation?”
“How do I hook a specific agent up to a chat thread I already started?”
Tell an agent
Attach agent {agent} to chat {chat}.
Add agent {agent} to the conversation in chat {chat}.
POST /textql.rpc.public.chat.ChatService/AttachApp Attach an app to a chat · AttachApp #
Ask an LLM
“How do I add a TextQL app to a chat so the analysis can use it?”
“Can a chat thread be linked to one of my apps?”
Tell an agent
Attach app {app} to chat {chat}.
Link the app {app} into chat thread {chat}.
POST /textql.rpc.public.chat.ChatService/AttachDashboard Attach a dashboard to a chat · AttachDashboard #
Ask an LLM
“Can I give a chat access to an existing dashboard as context?”
“How do I link a dashboard to a chat conversation?”
Tell an agent
Attach dashboard {dashboard} to chat {chat}.
Bring dashboard {dashboard} into the chat {chat} as context.
POST /textql.rpc.public.chat.ChatService/AttachDataset Attach a dataset to a chat · RateChatCell appends a row to cell_rating for every click; thumbs-down also… #
Ask an LLM
“How do I make an uploaded dataset available inside a chat?”
“Can a chat analyze a specific dataset I attach to it?”
Tell an agent
Attach dataset {dataset} to chat {chat}.
Add the dataset {dataset} to chat {chat} so it can be queried.
POST /textql.rpc.public.chat.ChatService/BookmarkChat Bookmark a chat · BookmarkChat #
Ask an LLM
“Can I bookmark a chat so it's easy to find later?”
“How do I star a conversation I want to keep handy?”
Tell an agent
Bookmark chat {chat}.
Save chat {chat} to my bookmarks.
POST /textql.rpc.public.chat.ChatService/CancelStream Stop a running chat response · CancelStream #
Ask an LLM
“How do I stop the agent mid-answer through the Connect chat service?”
“Can I cancel a chat that's still generating a response over RPC?”
Tell an agent destructive · confirm first
Cancel the in-progress response stream for chat {chat} via the chat service RPC.
Stop chat {chat} from generating any further output using the RPC cancel call.
POST /textql.rpc.public.chat.ChatService/CheckChatPermissions Check my permissions on a chat · CheckChatPermissions #
Ask an LLM
“What am I allowed to do on a given chat, like edit or share it?”
“How can I tell whether I have access to a particular chat?”
Tell an agent
Check what permissions I have on chat {chat}.
Tell me my access level for chat {chat}.
POST /textql.rpc.public.chat.ChatService/CheckHealth Check chat model health · CheckHealth #
Ask an LLM
“Is the chat model currently healthy and answering?”
“Can I run a functional health check against a specific chat model?”
Tell an agent
Run a health check on chat model {model}.
Do a functional health check of model {model} with functional set to {functional}.
POST /textql.rpc.public.chat.ChatService/CheckStreamlitHealth Check a Streamlit app's health in a chat · CheckStreamlitHealth #
Ask an LLM
“Is the Streamlit app generated in my chat cell still running?”
“How do I check whether a chat's Streamlit output is healthy?”
Tell an agent
Check the Streamlit health for cell {cell} in chat {chat}.
Verify the Streamlit app from chat {chat}, cell {cell}, is up.
POST /textql.rpc.public.chat.ChatService/CreateChat Start a new chat with a paradigm and model · CreateChat #
Ask an LLM
“How do I open a new chat session with a chosen paradigm and model over the Connect RPC?”
“Can I start a chat in research mode or fast mode from the start?”
Tell an agent
Start a new RPC chat using paradigm {paradigm} with opening message {message}.
Create a chat with paradigm {paradigm} on model {model} in research mode.
POST /textql.rpc.public.chat.ChatService/DeleteChat Delete a chat · DeleteChat #
Ask an LLM
“How do I delete a chat conversation I no longer need?”
“Can I permanently remove a chat thread?”
Tell an agent destructive · confirm first
Delete chat {chat}.
Remove the conversation {chat} from my chats.
POST /textql.rpc.public.chat.ChatService/DismissQuestions Dismiss the agent's clarifying questions · Resolve a halted questions cell. #
Ask an LLM
“What happens if I dismiss the agent's clarifying questions instead of answering them?”
“Can I skip a halted questions cell without resuming the agent?”
Tell an agent
Dismiss the questions in cell {cell} without resuming the agent.
Skip the clarifying questions in cell {cell}, keeping only these partial answers: {answers}.
POST /textql.rpc.public.chat.ChatService/DuplicateChat Duplicate a chat · DuplicateChat #
Ask an LLM
“Can I copy a chat to branch off a conversation?”
“Is it possible to duplicate a chat only up to a certain cell?”
Tell an agent
Duplicate chat {chat}.
Copy chat {chat} up to cell {cell} and switch the copy to model {model}.
POST /textql.rpc.public.chat.ChatService/GetAPIChatAnswer Get the final answer of an API chat · GetAPIChatAnswer #
Ask an LLM
“How do I fetch the final answer for a chat I started through the API?”
“Where can I read the answer text a programmatic chat produced?”
Tell an agent
Get the API chat answer for chat {chat}.
Fetch just the final answer produced in chat {chat}.
POST /textql.rpc.public.chat.ChatService/GetArtifact Get an artifact from a chat · GetArtifact #
Ask an LLM
“How do I retrieve a single chart or file the agent generated in a chat?”
“Can I download one specific artifact from a conversation?”
Tell an agent
Get artifact {artifact} from chat {chat}.
Open the generated artifact {artifact} in chat {chat}.
POST /textql.rpc.public.chat.ChatService/GetChat Get a chat's details over RPC · GetChat #
Ask an LLM
“How do I look up a chat's settings and metadata through the Connect chat service?”
“What paradigm and model is a given chat using?”
Tell an agent
Get the RPC chat record for {chat}.
Show the settings of chat {chat}.
POST /textql.rpc.public.chat.ChatService/GetChatArtifactsSummary Summarize the artifacts in a chat · GetChatArtifactsSummary #
Ask an LLM
“Which charts, tables and files did a chat produce overall?”
“Can I get an overview of every artifact generated in one conversation?”
Tell an agent
Summarize all artifacts generated in chat {chat}.
List the outputs chat {chat} has produced so far.
POST /textql.rpc.public.chat.ChatService/GetChatExecutionTiming Get execution timing for a chat · GetChatExecutionTiming #
Ask an LLM
“Why was my chat slow, and where did the time go?”
“How long did each step of a chat take to execute?”
Tell an agent
Show execution timing for chat {chat}.
Break down how long chat {chat} spent running.
POST /textql.rpc.public.chat.ChatService/GetChatHistory Get a chat's message history · GetChatHistory #
Ask an LLM
“How do I read back the full conversation history of a chat?”
“Can I page through older messages in a long chat?”
Tell an agent
Get the history of chat {chat}.
Show {limit} messages from chat {chat}, skipping the first {skip}.
POST /textql.rpc.public.chat.ChatService/GetChats Search and filter chats · GetChats #
Ask an LLM
“Can I find chats created by a specific teammate within a date range?”
“Which chats have I bookmarked or had shared with me?”
Tell an agent
Search the workspace's chats for {search_term}.
List chats created by member {creator} after {created_after}.
POST /textql.rpc.public.chat.ChatService/GetCompletionParameters Get completion parameters for a chat cell · List distinct chat creators the user can access #
Ask an LLM
“What model settings were used to generate a particular chat cell?”
“Can I inspect the LLM completion parameters behind one answer?”
Tell an agent
Get the completion parameters for cell {cell} in chat {chat}.
Show which LLM settings produced cell {cell} of chat {chat}.
POST /textql.rpc.public.chat.ChatService/GetCompletionParametersBatch Get completion parameters for many cells · GetCompletionParametersBatch #
Ask an LLM
“Can I fetch the LLM settings for several chat cells in one call?”
“How do I compare completion parameters across multiple cells of a chat?”
Tell an agent
Get completion parameters in batch for cells {cells} in chat {chat}.
Pull the model settings for every listed cell {cells} of chat {chat} at once.
POST /textql.rpc.public.chat.ChatService/GetLlmUsage Get LLM usage and cost for a chat · GetLlmUsage #
Ask an LLM
“How many tokens did a chat consume?”
“Can I see what a single conversation cost in LLM spend?”
Tell an agent
Show LLM usage for chat {chat}.
Get token usage for chat {chat} with costs included: {include_costs}.
POST /textql.rpc.public.chat.ChatService/GetMembersWithChats List members who have chats · GetMembersWithChats #
Ask an LLM
“Which people in my organization have created chats?”
“Who are the distinct chat creators I can filter by?”
Tell an agent
List the members who have chats, sending Connect protocol version {protocol_version}.
Show me every chat creator I can access, with a {timeout_ms} ms timeout.
POST /textql.rpc.public.chat.ChatService/GetPlaybookChats List the chats a playbook produced · GetPlaybookChats #
Ask an LLM
“Which chat runs has a scheduled playbook generated?”
“How do I see past executions of a playbook as chats?”
Tell an agent
List the chats for playbook {playbook}.
Show {limit} runs of playbook {playbook}.
POST /textql.rpc.public.chat.ChatService/PollChatEvents Poll for new events in a chat · PollChatEvents #
Ask an LLM
“How do I poll for progress updates while a chat is running instead of streaming?”
“Can I resume reading chat events from where I left off?”
Tell an agent
Poll for new events on chat {chat}.
Poll chat {chat} for events after cursor {cursor}.
POST /textql.rpc.public.chat.ChatService/QueryOneShot Ask a one-shot data question · QueryOneShot #
Ask an LLM
“Can I ask a single question about my data and get an answer without managing a conversation?”
“What's the quickest way to get a one-off answer from TextQL?”
Tell an agent
Ask the one-shot question {question} using paradigm {paradigm}.
Get a single answer to {question} with paradigm {paradigm} on model {model}.
POST /textql.rpc.public.chat.ChatService/RateChatCell Rate an answer in a chat · RateChatCell #
Ask an LLM
“How do I give a thumbs up or thumbs down to an agent's answer?”
“Can I explain why a chat response was wrong when I rate it?”
Tell an agent
Rate cell {cell} in chat {chat} as {rating}.
Give cell {cell} of chat {chat} a {rating} rating because {reason}.
POST /textql.rpc.public.chat.ChatService/RejectContextPromptChange Reject a proposed context prompt change · RejectContextPromptChange #
Ask an LLM
“Can I turn down a context prompt edit the agent proposed?”
“What if I don't want the agent's suggested context update applied?”
Tell an agent destructive · confirm first
Reject the context prompt change in cell {cell}.
Decline the agent's context edit proposed in cell {cell}.
POST /textql.rpc.public.chat.ChatService/RejectOntologyChange Reject a proposed ontology change · Resolve a halted ask_approval form cell. #
Ask an LLM
“How do I discard an ontology change the agent proposed in a chat?”
“Can I refuse a semantic model edit without it being applied?”
Tell an agent destructive · confirm first
Reject the ontology change proposed in cell {cell}.
Discard the ontology edit from chat cell {cell}.
POST /textql.rpc.public.chat.ChatService/RunChat Run or resume a chat · RunChat #
Ask an LLM
“How do I kick off the agent on a chat I already created?”
“Can I rerun a chat from its latest complete cell with a different model?”
Tell an agent
Run chat {chat}.
Resume chat {chat} from cell {cell} using model {model}.
POST /textql.rpc.public.chat.ChatService/SendMessage Send a follow-up message in a chat · SendMessage #
Ask an LLM
“How do I ask a follow-up question in an existing chat?”
“Can I include image URLs with a message to the agent?”
Tell an agent
Send {message} to chat {chat}.
Post {message} to chat {chat} with images {image_urls}.
POST /textql.rpc.public.chat.ChatService/SubmitContextPromptChange Submit an edited context prompt · SubmitContextPromptChange #
Ask an LLM
“Can I submit my own version of a context prompt change from a chat cell?”
“How do I hand back an edited context to the agent for review?”
Tell an agent
Submit edited context {edited_context} for cell {cell}.
Send my revised context prompt {edited_context} back on cell {cell}.
POST /textql.rpc.public.chat.ChatService/SubmitQuestions Answer the agent's clarifying questions · SubmitQuestions #
Ask an LLM
“How do I answer the questions the agent asked so it can continue?”
“Will submitting answers to a questions cell resume the agent?”
Tell an agent
Submit answers {answers} to the questions in cell {cell} and resume the agent.
Reply to the agent's clarifying questions in cell {cell} with {answers}.
POST /textql.rpc.public.chat.ChatService/UnbookmarkChat Remove a chat bookmark · UnbookmarkChat #
Ask an LLM
“How do I unbookmark a chat?”
“Can I take a conversation off my starred list?”
Tell an agent
Unbookmark chat {chat}.
Remove chat {chat} from my bookmarks.
POST /textql.rpc.public.chat.ChatService/UpdateChat Update a chat's settings or summary · UpdateChat #
Ask an LLM
“Can I rename or re-summarize an existing chat?”
“How do I switch a chat into research or dashboard mode after it started?”
Tell an agent
Set the summary of chat {chat} to {summary}.
Turn on research mode for chat {chat}.

Documentation

📖
Documentation
https://docs.textql.com/api-reference/v2/introduction
📖
APIReference
https://docs.textql.com/api-reference/v2/introduction
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/authentication/textql-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/rate-limits/textql-rate-limits.yml
📖
Documentation
https://docs.textql.com/api-reference/introduction
📖
APIReference
https://docs.textql.com/api-reference/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/openapi/textql-chatservice-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/scopes/textql-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/errors/textql-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/conventions/textql-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/data-model/textql-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/asyncapi/textql-webhooks.yml
🔗
Deprecation
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/lifecycle/textql-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/conformance/textql-conformance.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/textql:textql-chatservice-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

textql-chatservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: TextQL Chat Service API
  version: 1.0.0
  description: 'TextQL public API. Generated from protobuf service definitions; internal

    endpoints are excluded via google.api.visibility / file_visibility.'
servers:
- url: https://app.textql.com/rpc/public
security:
- apiKey: []
tags:


# --- truncated at 32 KB (289 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/openapi/textql-chatservice-api-openapi.yml