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 Playbook Service API

The PlaybookService API from TextQL — 39 operation(s) for playbookservice.

TextQL Playbook Service API is one of 39 APIs that TextQL publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PlaybookService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 39 operations across 39 paths, and defines 149 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.textql.com/rpc/public.

39 operations 39 paths 149 schemas 39 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.textql.com/v2
Authentication
API Key
Resource Areas
1

Authentication & Security 1

TextQL Playbook Service API declares 1 security scheme for authenticating requests. An API key is passed in the header as tql_api_key (apiKey). By default, every request must be authenticated.

Paths & Operations 39

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

PlaybookService 39
POST
/textql.rpc.public.playbook.PlaybookService/AttachDashboard
AttachDashboard
PlaybookService_AttachDashboard 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/AttachDataset
AttachDataset
PlaybookService_AttachDataset 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/CancelTemplateExecution
Cancel template execution for a specific template header
PlaybookService_CancelTemplateExecution 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/CreatePlaybook
CreatePlaybook
PlaybookService_CreatePlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/DeactivatePlaybook
DeactivatePlaybook
PlaybookService_DeactivatePlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/DeletePlaybook
DeletePlaybook
PlaybookService_DeletePlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/DemoPlaybook
DemoPlaybook
PlaybookService_DemoPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/DeployPlaybook
DeployPlaybook
PlaybookService_DeployPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/DuplicatePlaybook
DuplicatePlaybook
PlaybookService_DuplicatePlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/FavoriteReport
Favorite report management
PlaybookService_FavoriteReport 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetActiveSubscribedPlaybooksCount
GetActiveSubscribedPlaybooksCount
PlaybookService_GetActiveSubscribedPlaybooksCount 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetChatReportsSummary
Lightweight endpoint for chat report drawer - returns summaries without full…
PlaybookService_GetChatReportsSummary 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetMembersWithPlaybooks
GetMembersWithPlaybooks
PlaybookService_GetMembersWithPlaybooks 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetPlaybook
GetPlaybook
PlaybookService_GetPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetPlaybookBatchRun
Get a specific batch run
PlaybookService_GetPlaybookBatchRun 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetPlaybookLineage
GetPlaybookLineage
PlaybookService_GetPlaybookLineage 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetPlaybookReports
GetPlaybookReports
PlaybookService_GetPlaybookReports 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetPlaybookReportsBatch
Get reports for multiple template data IDs in a single batch request
PlaybookService_GetPlaybookReportsBatch 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetPlaybooks
GetPlaybooks
PlaybookService_GetPlaybooks 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetPlaybooksPreviews
GetPlaybooksPreviews
PlaybookService_GetPlaybooksPreviews 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetReportById
Get a single report by ID
PlaybookService_GetReportById 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/GetReportsWithFilters
GetReportsWithFilters
PlaybookService_GetReportsWithFilters 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/ListAllSlackChannelContextPlaybooks
List all Slack channels context playbook mappings for the organization
PlaybookService_ListAllSlackChannelContextPlaybooks 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/ListAllTeamsChannelContextPlaybooks
ListAllTeamsChannelContextPlaybooks
PlaybookService_ListAllTeamsChannelContextPlaybooks 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/ListPlaybookBatchRuns
List batch runs for a playbook
PlaybookService_ListPlaybookBatchRuns 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/ListSlackChannelsForContextPlaybook
List Slack channel IDs where the given playbook is set as the context
PlaybookService_ListSlackChannelsForContextPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/ListTeamsChannelsForContextPlaybook
ListTeamsChannelsForContextPlaybook
PlaybookService_ListTeamsChannelsForContextPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/MarkReportAsRead
Report read tracking
PlaybookService_MarkReportAsRead 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/PreviewSlackReport
PreviewSlackReport
PlaybookService_PreviewSlackReport 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/RemoveDashboard
RemoveDashboard
PlaybookService_RemoveDashboard 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/RemoveDataset
RemoveDataset
PlaybookService_RemoveDataset 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/RunPlaybook
RunPlaybook
PlaybookService_RunPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/SetSlackChannelContextPlaybook
Set the context playbook for a Slack channel.
PlaybookService_SetSlackChannelContextPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/SetTeamsChannelContextPlaybook
SetTeamsChannelContextPlaybook
PlaybookService_SetTeamsChannelContextPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/SubscribeToPlaybook
SubscribeToPlaybook
PlaybookService_SubscribeToPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/UnsetSlackChannelContextPlaybook
Unset the context playbook for a Slack channel.
PlaybookService_UnsetSlackChannelContextPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/UnsetTeamsChannelContextPlaybook
UnsetTeamsChannelContextPlaybook
PlaybookService_UnsetTeamsChannelContextPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/UnsubscribeFromPlaybook
UnsubscribeFromPlaybook
PlaybookService_UnsubscribeFromPlaybook 2 params body → default200
POST
/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook
UpdatePlaybook
PlaybookService_UpdatePlaybook 2 params body → default200

Schemas 149

The contract defines 149 schemas that model the data the API accepts and returns. The most detailed are textql.rpc.public.playbook.Playbook (44 properties), textql.rpc.public.paradigm.UniversalOptions (31 properties), textql.rpc.public.playbook.UpdatePlaybookRequest (30 properties), textql.rpc.public.dashboard.Dashboard (28 properties). Each schema is shown below with its type and property counts.

textql.rpc.public.playbook.RunPlaybookResponse
object
1 property
textql.rpc.public.playbook.SetTeamsChannelContextPlaybookResponse
object
1 property
textql.rpc.public.playbook.ListSlackChannelsForContextPlaybookResponse
object
1 property
textql.rpc.public.playbook.PlaybookPreview
object
4 properties
textql.rpc.public.playbook.DeployPlaybookRequest
object
1 property
textql.rpc.public.playbook.GetMembersWithPlaybooksRequest
object
textql.rpc.public.playbook.TeamsChannelPlaybookMapping
object
2 properties
textql.rpc.public.playbook.GetActiveSubscribedPlaybooksCountRequest
object
textql.rpc.public.playbook.PlaybookTriggerType
string
textql.rpc.public.dataset.TableauData
object
5 properties
textql.rpc.public.playbook.RunPlaybookRequest
object
3 properties
textql.rpc.public.playbook.GetReportsWithFiltersRequest
object
1 property
textql.rpc.public.playbook.SetSlackChannelContextPlaybookRequest
object
Associates a playbook to a Slack channel as its context playbook.
2 properties
textql.rpc.public.playbook.GetPlaybooksRequest
object
14 properties
textql.rpc.public.cells.ReportCell
object
6 properties
textql.rpc.public.playbook.UnsetSlackChannelContextPlaybookRequest
object
Unsets the context playbook for a Slack channel by channel ID only.
1 property
textql.rpc.public.playbook.PlaybookAttachDatasetRequest
object
2 properties
textql.rpc.public.playbook.FavoriteReportResponse
object
1 property
textql.rpc.public.playbook.PreviewSlackReportResponse
object
textql.rpc.public.playbook.DeactivatePlaybookRequest
object
1 property
textql.rpc.public.playbook.Playbook
object
44 properties
textql.rpc.public.playbook.ChatReportSummary
object
Lightweight report summary for chat drawer - excludes full blocks
6 properties
textql.rpc.public.dashboard.QueryParameter
object
3 properties
textql.rpc.public.dashboard.PythonCodeSource
object
1 property
textql.rpc.public.reports.ImageTextBlock
object
5 properties
textql.rpc.public.dashboard.Dashboard
object
28 properties
textql.rpc.public.playbook.PreviewSlackReportRequest
object
4 properties
textql.rpc.public.playbook.PlaybookAttachDashboardRequest
object
2 properties
textql.rpc.public.playbook.ReportFilters
object
12 properties
textql.rpc.public.playbook.ChatAccessOverrideList
object
1 property
textql.rpc.public.playbook.ListPlaybookBatchRunsRequest
object
Request to list batch runs for a playbook
3 properties
textql.rpc.identity.MemberPreview
object
4 properties
textql.rpc.public.dashboard.DataSource
object
Unified data source for dashboards
textql.rpc.public.playbook.UnsetTeamsChannelContextPlaybookResponse
object
1 property
textql.rpc.public.playbook.UnsetSlackChannelContextPlaybookResponse
object
1 property
textql.rpc.public.playbook.UnsubscribeFromPlaybookRequest
object
1 property
textql.rpc.public.reports.ReportBlock
object
textql.rpc.public.dataset.SandboxDataFrame
object
1 property
textql.rpc.public.playbook.CancelTemplateExecutionResponse
object
Response from canceling template execution
2 properties
connect-timeout-header
number
Define the timeout, in ms
textql.rpc.public.playbook.ListTeamsChannelsForContextPlaybookRequest
object
1 property
textql.rpc.public.chat.LlmModel
string
textql.rpc.public.playbook.GetPlaybookLineageResponse
object
3 properties
textql.rpc.public.tableau.TableauDatasource
object
TODO: Add datasources support
8 properties
textql.rpc.public.playbook.UnsetTeamsChannelContextPlaybookRequest
object
1 property
textql.rpc.public.dashboard.OntologySqlSource
object
3 properties
textql.rpc.public.playbook.DeletePlaybookResponse
object
2 properties
textql.rpc.public.playbook.UpdatePlaybookRequest
object
30 properties
textql.rpc.public.playbook.MarkReportAsReadResponse
object
2 properties
textql.rpc.public.playbook.PlaybookRemoveDashboardRequest
object
2 properties
textql.rpc.public.dataset.Dataset
object
textql.rpc.public.playbook.SubscribeToPlaybookRequest
object
1 property
textql.rpc.public.reports.CardBlock
object
1 property
textql.rpc.public.playbook.PlaybookRemoveDatasetResponse
object
1 property
textql.rpc.public.dashboard.Grant
object
Grant is an author allowlist gating a data source or compute function. A viewer whose effective role names intersect roles, or whose member id is listed in mem…
2 properties
textql.rpc.public.playbook.ListAllTeamsChannelContextPlaybooksRequest
object
textql.rpc.public.reports.ImageVariant
string
textql.rpc.public.playbook.GetReportsWithFiltersResponse
object
4 properties
textql.rpc.public.playbook.GetReportByIdResponse
object
1 property
textql.rpc.public.playbook.DuplicatePlaybookRequest
object
1 property
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
3 properties
textql.rpc.public.playbook.GetReportByIdRequest
object
1 property
textql.rpc.public.reports.ListBlock
object
2 properties
textql.rpc.public.reports.SpacerBlock
object
1 property
textql.rpc.public.playbook.PlaybookLineageNode
object
5 properties
textql.rpc.powerbi_selection.PowerBISelection
object
PowerBISelection captures a chosen PowerBI workspace (and optionally the specific reports/datasets within it) for attaching to a chat. Field shape mirrors text…
5 properties
textql.rpc.public.playbook.SlackChannelPlaybookMapping
object
Maps playbook to its associated Slack channel
2 properties
textql.rpc.paradigm_params.ParadigmType
string
textql.rpc.public.playbook.SetSlackChannelContextPlaybookResponse
object
1 property
textql.rpc.public.playbook.ListTeamsChannelsForContextPlaybookResponse
object
1 property
textql.rpc.public.paradigm.UniversalOptions
object
31 properties
textql.rpc.public.playbook.StringList
object
1 property
textql.rpc.public.paradigm.ParadigmOptions
object
textql.rpc.public.playbook.PlaybookAttachDatasetResponse
object
1 property
textql.rpc.public.playbook.PlaybookReport
object
11 properties
textql.rpc.public.reports.HeroBlock
object
2 properties
textql.rpc.public.dataset.Document
object
2 properties
textql.rpc.public.playbook.CancelTemplateExecutionRequest
object
Request to cancel template execution
2 properties
textql.rpc.public.playbook.GetPlaybooksPreviewsRequest
object
2 properties
textql.rpc.public.playbook.GetPlaybookReportsBatchRequest
object
Batch request to get reports for multiple template data IDs efficiently
4 properties
textql.rpc.public.playbook.GetPlaybookLineageRequest
object
1 property
textql.rpc.public.playbook.DeletePlaybookRequest
object
1 property
textql.rpc.public.reports.DividerBlock
object
textql.rpc.public.dataframe.DataFrameInfo
object
5 properties
textql.rpc.public.dashboard.LibraryTQLSource
object
References a .tql file stored in the Context Library. The file is rendered to SQL at fetch time and executed against the provided connector. Template parameter…
3 properties
textql.rpc.public.playbook.PlaybookRemoveDashboardResponse
object
1 property
textql.rpc.public.playbook.DemoPlaybookResponse
object
textql.rpc.public.playbook.SetTeamsChannelContextPlaybookRequest
object
2 properties
textql.rpc.public.playbook.SubscribeToPlaybookResponse
object
1 property
textql.rpc.public.playbook.PlaybookAttachDashboardResponse
object
1 property
textql.rpc.public.dataset.DatasetType
string
never change the names or numbers of existing dataset types!
textql.rpc.public.playbook.GetChatReportsSummaryResponse
object
1 property
textql.rpc.public.playbook.ListAllSlackChannelContextPlaybooksRequest
object
List all Slack channel context playbook mappings for organization
textql.rpc.public.playbook.GetChatReportsSummaryRequest
object
1 property
textql.rpc.public.dataset.TabularFileCategory
string
never change the names or numbers of existing tabular file categories!
textql.rpc.public.common.SortDirection
string
Common enum for sort direction used across multiple services
textql.rpc.public.dataset.PowerBIData
object
7 properties
textql.rpc.public.playbook.GetPlaybookReportsRequest
object
6 properties
textql.rpc.public.playbook.PlaybookRemoveDatasetRequest
object
2 properties
textql.rpc.public.playbook.ListPlaybookBatchRunsResponse
object
Response containing list of batch runs
2 properties
textql.rpc.public.playbook.ListAllSlackChannelContextPlaybooksResponse
object
1 property
textql.rpc.public.playbook.UpdatePlaybookResponse
object
1 property
textql.rpc.public.reports.TextBlock
object
2 properties
textql.rpc.public.playbook.GetMembersWithPlaybooksResponse
object
1 property
textql.rpc.public.cells.PreviewCellRef
object
Preview cell reference for report history
4 properties
textql.rpc.public.dataset.TabularFile
object
4 properties
textql.rpc.public.playbook.FilterConditionList
object
1 property
textql.rpc.public.playbook.GetPlaybookReportsBatchResponse
object
Batch response with reports grouped by templatedataid
1 property
textql.rpc.public.playbook.PlaybookSortField
string
textql.rpc.public.playbook.UnsubscribeFromPlaybookResponse
object
1 property
textql.rpc.public.dashboard.FileSource
object
3 properties
textql.rpc.public.playbook.DeployPlaybookResponse
object
2 properties
textql.rpc.public.playbook.PlaybookReportStyle
string
textql.rpc.public.playbook.MarkReportAsReadRequest
object
Report read tracking messages
1 property
textql.rpc.public.playbook.ListSlackChannelsForContextPlaybookRequest
object
Lists Slack channel IDs that have this playbook set as the context playbook.
1 property
textql.rpc.public.playbook.FavoriteReportRequest
object
Favorite report messages
2 properties
textql.rpc.public.playbook.CreatePlaybookResponse
object
1 property
textql.rpc.public.tableau.TableauView
object
8 properties
textql.rpc.public.playbook.GetPlaybooksResponse
object
2 properties
textql.rpc.public.dashboard.DashboardStatus
string
textql.rpc.public.playbook.DemoPlaybookRequest
object
4 properties
textql.rpc.public.dashboard.DashboardType
string
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…
textql.rpc.public.config_source.ConfigSyncStatus
string
textql.rpc.public.playbook.ChatAccessMode
string
textql.rpc.public.playbook.GetActiveSubscribedPlaybooksCountResponse
object
1 property
textql.rpc.public.playbook.GetPlaybookRequest
object
3 properties
textql.rpc.public.playbook.GetPlaybookBatchRunResponse
object
Response containing batch run details
1 property
textql.rpc.public.playbook.GetPlaybookBatchRunRequest
object
Request to get a specific batch run
1 property
textql.rpc.public.playbook.TemplateDataReports
object
Grouped reports by templatedataid
4 properties
textql.rpc.public.playbook.PlaybookStatus
string
textql.rpc.public.playbook.ListAllTeamsChannelContextPlaybooksResponse
object
1 property
connect-protocol-version
number
Define the version of the Connect protocol
textql.rpc.public.config_source.ConfigSource
object
Config-management metadata (provenance + reconcile state) for any file-based object. Presence on an object ⇒ the object is config-managed.
4 properties
textql.rpc.public.playbook.DuplicatePlaybookResponse
object
1 property
textql.rpc.public.playbook.ChatAccessOverride
object
3 properties
google.protobuf.Empty
object
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the resp…
textql.rpc.public.playbook.GetPlaybookReportsResponse
object
2 properties
textql.rpc.public.playbook.GetPlaybookResponse
object
3 properties
textql.rpc.public.playbook.GetPlaybooksPreviewsResponse
object
1 property
textql.rpc.public.playbook.PlaybookBatchRun
object
Batch run record
5 properties
textql.rpc.public.dataset.DatasetPermission
string
textql.rpc.public.playbook.CreatePlaybookRequest
object
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
textql.rpc.public.dashboard.DashboardCreator
object
3 properties
textql.rpc.public.playbook.FilterCondition
object
Filter condition for template data searches
3 properties
textql.rpc.public.reports.ImageBlock
object
3 properties
textql.rpc.public.playbook.Int32List
object
1 property
textql.rpc.public.dashboard.SqlQuerySource
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

textql-playbookservice-api-openapi.yml Raw ↑

Other APIs TextQL publishes across the network.

Ana MCP Server
TextQL Agent Service API
TextQL API Keys API
TextQL App Service API
TextQL Audit Log Service API
TextQL Changes API
TextQL Chat API
TextQL Chat Service API
TextQL Connectors API
TextQL Connector Service API
TextQL Dashboard Service API
TextQL Dataset Service API
Where this information came from

This is an independent, third-party profile of TextQL Playbook Service API, 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.