How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TextQL Platform API (v1)

The first-generation TextQL Platform API, exposed as Connect-RPC over HTTP POST. Documented as deprecated in favour of the v2 REST API but still published and served. Covers chat execution and streaming, playbook lifecycle, agent webhooks, connector listing, the Python sandbox, and outbound API access keys for external providers.

This API exposes 4 operations across 5 paths, and defines 173 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against the base URL https://app.textql.com/v1.

4 operations 5 paths 173 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://app.textql.com/v1
Resource Areas
1

Paths & Operations 4

Across 5 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

textql.rpc.platform.ChatService 4

Platform Chat Service - External API for chat management

POST
/v1/chat/cancel
CancelStream
textql.rpc.platform.ChatService.CancelStream 2 params body → default200
POST
/v1/chat
Chat
textql.rpc.platform.ChatService.Chat 2 params body → default200
POST
/v1/chat/get
GetChat
textql.rpc.platform.ChatService.GetChat 2 params body → default200
POST
/v1/chat/list
ListChats
textql.rpc.platform.ChatService.ListChats 2 params body → default200

Schemas 173

The contract defines 173 schemas that model the data the API accepts and returns. The most detailed are textql.rpc.public.cells.OntologyEditorCell (23 properties), textql.rpc.public.chat.Chat (20 properties), textql.rpc.public.paradigm.UniversalOptions (20 properties), textql.rpc.public.cells.PlaybookInfo (18 properties). Each schema is shown below with its type and property counts.

connect-protocol-version
number
Define the version of the Connect protocol
connect-timeout-header
number
Define the timeout, in ms
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
3 properties
connect.error_details.Any
object
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC er…
3 properties
google.protobuf.ListValue
object
ListValue is a wrapper around a repeated field of values. The JSON representation for ListValue is JSON array.
1 property
google.protobuf.NullValue
string
NullValue is a singleton enumeration to represent the null value for the Value type union. The JSON representation for NullValue is JSON null.
google.protobuf.Struct
object
Struct represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, Struct might be supported by a native…
google.protobuf.Struct.FieldsEntry
object
2 properties
google.protobuf.Timestamp
string
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond res…
google.protobuf.Value
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer o…
textql.rpc.identity.MemberPreview
object
4 properties
textql.rpc.paradigm_params.ParadigmType
string
textql.rpc.platform.ChatRequest
object
3 properties
textql.rpc.platform.ChatResponse
object
7 properties
textql.rpc.platform.ChatStatus
string
textql.rpc.platform.ChatTools
object
10 properties
textql.rpc.platform.ChatUsage
object
7 properties
textql.rpc.platform.StopReason
string
textql.rpc.platform.StreamChatMetadata
object
9 properties
textql.rpc.platform.StreamChatMetadata.MetadataEntry
object
2 properties
textql.rpc.platform.StreamRequest
object
3 properties
textql.rpc.platform.StreamResponse
object
textql.rpc.public.cells.AnswerCell
object
3 properties
textql.rpc.public.cells.BashCell
object
4 properties
textql.rpc.public.cells.ConnectorRef
object
Reference types for context data
3 properties
textql.rpc.public.cells.ContextPromptChangeStatus
string
textql.rpc.public.cells.ContextPromptEditorAction
string
textql.rpc.public.cells.ContextPromptEditorCell
object
7 properties
textql.rpc.public.cells.DashboardAction
string
textql.rpc.public.cells.DashboardCell
object
10 properties
textql.rpc.public.cells.DateRange
string
textql.rpc.public.cells.DocumentCell
object
5 properties
textql.rpc.public.cells.EditableForm
object
7 properties
textql.rpc.public.cells.EditableFormStatus
string
textql.rpc.public.cells.ExaSearchResult
object
11 properties
textql.rpc.public.cells.FeedCommentCell
object
6 properties
textql.rpc.public.cells.FeedEngageCell
object
6 properties
textql.rpc.public.cells.FeedExplorerCell
object
5 properties
textql.rpc.public.cells.FeedPostCell
object
10 properties
textql.rpc.public.cells.FileReference
object
3 properties
textql.rpc.public.cells.FormEditorAction
string
textql.rpc.public.cells.FormEditorCell
object
4 properties
textql.rpc.public.cells.GoogleDriveContentCell
object
5 properties
textql.rpc.public.cells.GoogleDriveFile
object
6 properties
textql.rpc.public.cells.GoogleDriveSearchCell
object
4 properties
textql.rpc.public.cells.ImageCell
object
9 properties
textql.rpc.public.cells.ImageReference
object
2 properties
textql.rpc.public.cells.JavaScriptCell
object
5 properties
textql.rpc.public.cells.MCPToolCell
object
7 properties
textql.rpc.public.cells.MarkdownCell
object
2 properties
textql.rpc.public.cells.MetricsCell
object
8 properties
textql.rpc.public.cells.Microsoft365CalendarCell
object
3 properties
textql.rpc.public.cells.Microsoft365EmailContentCell
object
4 properties
textql.rpc.public.cells.Microsoft365EmailSearchCell
object
3 properties
textql.rpc.public.cells.OntologyEditorAction
string
textql.rpc.public.cells.OntologyEditorCell
object
23 properties
textql.rpc.public.cells.OntologyEditorListFilter
object
1 property
textql.rpc.public.cells.OntologyEditorListType
string
textql.rpc.public.cells.OntologyEditorOperation
string
textql.rpc.public.cells.OntologyEditorStatus
string
textql.rpc.public.cells.OrgMemberRef
object
2 properties
textql.rpc.public.cells.PlaybookEditorAction
string
textql.rpc.public.cells.PlaybookEditorCell
object
10 properties
textql.rpc.public.cells.PlaybookFieldChange
object
Represents a change to a playbook field during an update
3 properties
textql.rpc.public.cells.PlaybookInfo
object
Simplified playbook info for display in cells
18 properties
textql.rpc.public.cells.PlaybookReportStyleLight
string
Playbook report output style - matches parseReportStyle in playbookhelpers.go REPORTSTYLEEXECUTIVE = "ExecutiveReport" or "Executive" REPORTSTYLEVERBOSE = "Ver…
textql.rpc.public.cells.PlaybookStatusLight
string
TODO(joseph): Clean up base enums // messages etc.
textql.rpc.public.cells.PowerBICell
object
4 properties
textql.rpc.public.cells.PowerBIDAXCell
object
4 properties
textql.rpc.public.cells.PowerBIMessageBlock
object
2 properties
textql.rpc.public.cells.PreviewCell
object
primary interface for ana to render sandbox assets client side
6 properties
textql.rpc.public.cells.PreviewCellRef
object
Preview cell reference for report history
4 properties
textql.rpc.public.cells.PythonCell
object
11 properties
textql.rpc.public.cells.ReportCell
object
6 properties
textql.rpc.public.cells.ReportHistoryCell
object
3 properties
textql.rpc.public.cells.ReportHistoryInfo
object
Simplified report info for report history cell
10 properties
textql.rpc.public.cells.SQLCell
object
12 properties
textql.rpc.public.cells.SQLReference
object
1 property
textql.rpc.public.cells.SlackChannelRef
object
2 properties
textql.rpc.public.cells.SlackUserRef
object
2 properties
textql.rpc.public.cells.StatusCell
object
1 property
textql.rpc.public.cells.StreamlitCell
object
4 properties
textql.rpc.public.cells.SummaryCell
object
1 property
textql.rpc.public.cells.TableauCell
object
2 properties
textql.rpc.public.cells.TableauMessageBlock
object
3 properties
textql.rpc.public.cells.TableauSQLCell
object
4 properties
textql.rpc.public.cells.TableauSearchFieldsCell
object
2 properties
textql.rpc.public.cells.TabularFileCell
object
4 properties
textql.rpc.public.cells.TextCell
object
6 properties
textql.rpc.public.cells.WebSearchCell
object
6 properties
textql.rpc.public.cells.WebSearchType
string
textql.rpc.public.chat.CancelStreamRequest
object
1 property
textql.rpc.public.chat.CancelStreamResponse
object
1 property
textql.rpc.public.chat.Cell
object
textql.rpc.public.chat.CellLifecycle
string
textql.rpc.public.chat.Chat
object
20 properties
textql.rpc.public.chat.ChatMessage
object
3 properties
textql.rpc.public.chat.ChatSource
string
textql.rpc.public.chat.GetChatsRequest
object
6 properties
textql.rpc.public.chat.GetChatsResponse
object
2 properties
textql.rpc.public.chat.GetChatRequest
object
1 property
textql.rpc.public.chat.GetChatResponse
object
3 properties
textql.rpc.public.chat.LlmModel
string
textql.rpc.public.chat.Methodology
string
textql.rpc.public.connector.ConnectorType
string
textql.rpc.public.dashboard.DataSource
object
Unified data source for dashboards
textql.rpc.public.dashboard.FileSource
object
2 properties
textql.rpc.public.dashboard.OntologySqlSource
object
3 properties
textql.rpc.public.dashboard.PythonCodeSource
object
1 property
textql.rpc.public.dashboard.SqlQuerySource
object
2 properties
textql.rpc.public.dataframe.BoolValues
object
1 property
textql.rpc.public.dataframe.ByteValues
object
1 property
textql.rpc.public.dataframe.DataFrame
object
2 properties
textql.rpc.public.dataframe.DataFrameColumn
object
textql.rpc.public.dataframe.DataFrameField
object
3 properties
textql.rpc.public.dataframe.DataFrameInfo
object
5 properties
textql.rpc.public.dataframe.DataFrameRecord
object
1 property
textql.rpc.public.dataframe.DataFrameWithInfo
object
3 properties
textql.rpc.public.dataframe.DoubleValues
object
1 property
textql.rpc.public.dataframe.FloatValues
object
1 property
textql.rpc.public.dataframe.Int32Values
object
1 property
textql.rpc.public.dataframe.Int64Values
object
1 property
textql.rpc.public.dataframe.StringValues
object
1 property
textql.rpc.public.dataframe.TimestampValues
object
1 property
textql.rpc.public.dataframe.Uint32Values
object
1 property
textql.rpc.public.dataframe.Uint64Values
object
1 property
textql.rpc.public.dataset.Dataset
object
textql.rpc.public.dataset.DatasetPermission
string
textql.rpc.public.dataset.DatasetType
string
never change the names or numbers of existing dataset types!
textql.rpc.public.dataset.Document
object
2 properties
textql.rpc.public.dataset.PowerBIData
object
3 properties
textql.rpc.public.dataset.SandboxDataFrame
object
1 property
textql.rpc.public.dataset.TableauData
object
5 properties
textql.rpc.public.dataset.TabularFile
object
4 properties
textql.rpc.public.dataset.TabularFileCategory
string
never change the names or numbers of existing tabular file categories!
textql.rpc.public.ontology.AttributeData
object
textql.rpc.public.ontology.AttributeRef
object
1 property
textql.rpc.public.ontology.GraphPosition
object
2 properties
textql.rpc.public.ontology.GraphProperties
object
3 properties
textql.rpc.public.ontology.IntermediateJoin
object
3 properties
textql.rpc.public.ontology.LinkedAttributeData
object
2 properties
textql.rpc.public.ontology.MetricAggregation
string
textql.rpc.public.ontology.ObjectRef
object
1 property
textql.rpc.public.ontology.OntologyAttribute
object
10 properties
textql.rpc.public.ontology.OntologyAttributeType
string
textql.rpc.public.ontology.OntologyMetric
object
11 properties
textql.rpc.public.ontology.OntologyObject
object
Ontology entities
textql.rpc.public.ontology.OntologyRelation
object
10 properties
textql.rpc.public.ontology.RelationType
string
textql.rpc.public.ontology.TableName
object
Core data types
3 properties
textql.rpc.public.ontology.UnlinkedAttributeData
object
1 property
textql.rpc.public.paradigm.BasicOptions
object
This is a placeholder for future basic options. Currently, it does not contain any fields.
textql.rpc.public.paradigm.ExperimentalOptions
object
2 properties
textql.rpc.public.paradigm.OntologyOptions
object
2 properties
textql.rpc.public.paradigm.Paradigm
object
ChatParadigm includes paradigm options
3 properties
textql.rpc.public.paradigm.ParadigmOptions
object
textql.rpc.public.paradigm.PublicDemoOptions
object
1 property
textql.rpc.public.paradigm.ResearchOptions
object
3 properties
textql.rpc.public.paradigm.SqlOptions
object
1 property
textql.rpc.public.paradigm.TableauOptions
object
1 property
textql.rpc.public.paradigm.UniversalOptions
object
20 properties
textql.rpc.public.reports.CardBlock
object
1 property
textql.rpc.public.reports.DividerBlock
object
textql.rpc.public.reports.HeroBlock
object
2 properties
textql.rpc.public.reports.ImageBlock
object
3 properties
textql.rpc.public.reports.ImageTextBlock
object
5 properties
textql.rpc.public.reports.ImageVariant
string
textql.rpc.public.reports.ListBlock
object
2 properties
textql.rpc.public.reports.ReportBlock
object
textql.rpc.public.reports.SpacerBlock
object
1 property
textql.rpc.public.reports.TextBlock
object
2 properties
textql.rpc.public.tableau.TableauDatasource
object
TODO: Add datasources support
8 properties
textql.rpc.public.tableau.TableauView
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

textql-chat-v1-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of TextQL Platform API (v1), published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.