Generated by API Evangelist
Written by API Evangelist tooling for TextQL's API. It is a proposal applied on top of the contract, not a document TextQL publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Textql.rpc.platform.Chat Service API
version: 1.0.0
extends: openapi/textql-textql-rpc-platform-chatservice-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/v1/chat/cancel'].post
update:
x-apievangelist-phrasing:
intent: Cancel a streaming chat response
effect: destructive
questions:
- Can I stop an answer that's still streaming?
- How do I cancel a long-running chat response?
instructions:
- text: Cancel the stream in chat {chat_id}.
slots:
chat_id: requestBody.chatId
- text: Stop generating the answer for chat {chat_id}.
slots:
chat_id: requestBody.chatId
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/chat'].post
update:
x-apievangelist-phrasing:
intent: Ask TextQL a question
effect: write
questions:
- How do I ask a question about my data in plain English?
- Can I continue an existing chat with a follow-up?
- Which tools can a chat question use?
instructions:
- text: 'Ask: {question}.'
slots:
question: requestBody.question
- text: Ask {question} as a follow-up in chat {chat_id}.
slots:
question: requestBody.question
chat_id: requestBody.chatId
- text: Answer {question} using tools {tools}.
slots:
question: requestBody.question
tools: requestBody.tools
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/chat/get'].post
update:
x-apievangelist-phrasing:
intent: Get a chat conversation
effect: read
questions:
- Can I retrieve a past chat and its answers?
- What was said in a specific chat?
instructions:
- text: Get chat {chat_id}.
slots:
chat_id: requestBody.chatId
- text: Open the conversation {chat_id}.
slots:
chat_id: requestBody.chatId
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/chat/list'].post
update:
x-apievangelist-phrasing:
intent: List and search chats
effect: read
questions:
- Which chats have I had recently?
- Can I search chats by their summary or first message?
- Is it possible to see all chats in the org, not just mine?
instructions:
- text: List my recent chats.
- text: Search chats for {search_term}.
slots:
search_term: requestBody.searchTerm
- text: Show {limit} chats skipping the first {offset}.
slots:
limit: requestBody.limit
offset: requestBody.offset
method: generated
generated: '2026-10-01'
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.