TextQL

TextQL Playbook Service API

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

GitHub OpenAPI
Business capability
Analytics & BI Management BC-610.50

Operations 39

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.playbook.PlaybookService/AttachDashboard Attach a dashboard to a playbook · AttachDashboard #
Ask an LLM
“Can a playbook include one of my existing dashboards?”
“What does linking a dashboard to a scheduled playbook do?”
Tell an agent
Attach dashboard {dashboard_id} to playbook {playbook_id}.
Link the dashboard {dashboard_id} into my playbook {playbook_id} so its runs can use it.
POST /textql.rpc.public.playbook.PlaybookService/AttachDataset Attach a dataset to a playbook · AttachDataset #
Ask an LLM
“How do I give a playbook access to another dataset?”
“Can I add a dataset to a playbook after it's been created?”
Tell an agent
Attach dataset {dataset_id} to playbook {playbook_id}.
Add the dataset {dataset_id} as a data source for playbook {playbook_id}.
POST /textql.rpc.public.playbook.PlaybookService/CancelTemplateExecution Cancel a playbook's template execution · Cancel template execution for a specific template header #
Ask an LLM
“Can I stop a templated playbook run that is still executing?”
“Is there a way to cancel execution for one template header in a playbook?”
Tell an agent destructive · confirm first
Cancel template execution for template header {template_header_id} in playbook {playbook_id}.
Stop the running templated executions under header {template_header_id}.
POST /textql.rpc.public.playbook.PlaybookService/CreatePlaybook Create a new playbook · CreatePlaybook #
Ask an LLM
“How do I start a new TextQL playbook?”
“Can I create a blank playbook and configure it afterwards?”
Tell an agent
Create a new empty playbook for me.
Start a fresh playbook, waiting at most {timeout_ms} ms for the call.
POST /textql.rpc.public.playbook.PlaybookService/DeactivatePlaybook Deactivate a playbook · DeactivatePlaybook #
Ask an LLM
“How can I pause a playbook so it stops running on its schedule?”
“Can I turn a playbook off without deleting it?”
Tell an agent
Deactivate playbook {playbook_id}.
Switch off playbook {playbook_id} but keep it around.
POST /textql.rpc.public.playbook.PlaybookService/DeletePlaybook Delete a playbook · DeletePlaybook #
Ask an LLM
“How do I permanently remove a playbook?”
“What happens to a playbook when I delete it instead of deactivating it?”
Tell an agent destructive · confirm first
Delete playbook {playbook_id}.
Permanently remove the playbook {playbook_id} from my organization.
POST /textql.rpc.public.playbook.PlaybookService/DemoPlaybook Generate a demo playbook for a prospect · DemoPlaybook #
Ask an LLM
“Can I build a demo playbook from a chat for a specific person and job title?”
“Which details does a personalized demo playbook need about the recipient?”
Tell an agent
Create a demo playbook from chat {chat_id} for {person_name}, {job_title}, sent to {target_email}.
Demo a playbook built on chat {chat_id} for {target_email}.
POST /textql.rpc.public.playbook.PlaybookService/DeployPlaybook Deploy a playbook · DeployPlaybook #
Ask an LLM
“How do I take a draft playbook live?”
“What makes a playbook start running on its trigger?”
Tell an agent
Deploy playbook {playbook_id}.
Publish my draft playbook {playbook_id} so it goes live.
POST /textql.rpc.public.playbook.PlaybookService/DuplicatePlaybook Duplicate a playbook · DuplicatePlaybook #
Ask an LLM
“Can I copy an existing playbook as a starting point for a new one?”
“Is there a way to clone a playbook with its settings?”
Tell an agent
Duplicate playbook {playbook_id}.
Make a copy of the playbook {playbook_id}.
POST /textql.rpc.public.playbook.PlaybookService/FavoriteReport Favorite a playbook report · Favorite report management #
Ask an LLM
“Can I star a playbook report so it's easy to find later?”
“How do I mark a report as a favorite?”
Tell an agent
Favorite report {report_id} from playbook {playbook_id}.
Add report {report_id} to my favorites.
POST /textql.rpc.public.playbook.PlaybookService/GetActiveSubscribedPlaybooksCount Count active playbooks I'm subscribed to · GetActiveSubscribedPlaybooksCount #
Ask an LLM
“How many active playbooks am I subscribed to?”
“What's the count of live playbooks I follow?”
Tell an agent
Tell me how many active playbooks I'm subscribed to.
Count my active playbook subscriptions with a {timeout_ms} ms timeout.
POST /textql.rpc.public.playbook.PlaybookService/GetChatReportsSummary Summarize the reports produced in a chat · Lightweight endpoint for chat report drawer - returns summaries without full… #
Ask an LLM
“Can I get a lightweight summary of the reports in a chat without the full content?”
“What reports were generated in this chat?”
Tell an agent
Summarize the reports in chat {chat_id}.
Show the report drawer summaries for chat {chat_id}, without full blocks.
POST /textql.rpc.public.playbook.PlaybookService/GetMembersWithPlaybooks List members who own playbooks · GetMembersWithPlaybooks #
Ask an LLM
“Which people in my organization have created playbooks?”
“Who are the playbook creators I can filter by?”
Tell an agent
List the members who have playbooks.
Show every playbook creator in the org, timing out after {timeout_ms} ms.
POST /textql.rpc.public.playbook.PlaybookService/GetPlaybook Get a playbook's details · GetPlaybook #
Ask an LLM
“What's configured on a specific playbook?”
“Can I page through the items returned with a single playbook?”
Tell an agent
Get playbook {playbook_id}.
Fetch playbook {playbook_id} with {limit} entries starting at offset {offset}.
POST /textql.rpc.public.playbook.PlaybookService/GetPlaybookBatchRun Get a playbook batch run · Get a specific batch run #
Ask an LLM
“What's the status of a specific playbook batch run?”
“Can I look up one batch run by its ID?”
Tell an agent
Get batch run {batch_run_id}.
Show me the details of playbook batch run {batch_run_id}.
POST /textql.rpc.public.playbook.PlaybookService/GetPlaybookLineage Get a playbook's data lineage · GetPlaybookLineage #
Ask an LLM
“Which data sources does a playbook depend on?”
“Can I see the lineage of a playbook?”
Tell an agent
Show the lineage for playbook {playbook_id}.
Trace where playbook {playbook_id} gets its data from.
POST /textql.rpc.public.playbook.PlaybookService/GetPlaybookReports List reports a playbook has produced · GetPlaybookReports #
Ask an LLM
“What reports has a playbook generated so far?”
“Can I filter a playbook's reports to a single batch run?”
Tell an agent
List the reports from playbook {playbook_id}.
Show reports from playbook {playbook_id} produced in batch run {batch_run_id}.
POST /textql.rpc.public.playbook.PlaybookService/GetPlaybookReportsBatch Fetch reports for several template data rows · Get reports for multiple template data IDs in a single batch request #
Ask an LLM
“Can I fetch reports for many template data IDs in one request?”
“Is there a cap on how many reports come back per template?”
Tell an agent
Get reports for template data IDs {template_data_ids} in playbook {playbook_id}.
Batch-fetch up to {limit_per_template} reports per template for {template_data_ids}.
POST /textql.rpc.public.playbook.PlaybookService/GetPlaybooks Search and list playbooks · GetPlaybooks #
Ask an LLM
“How do I find playbooks by name or status?”
“Can I list only the playbooks shared with me or the ones I subscribe to?”
Tell an agent
Search my playbooks for {search_term}.
List playbooks created by {creator_member_ids}.
POST /textql.rpc.public.playbook.PlaybookService/GetPlaybooksPreviews Get lightweight playbook previews · GetPlaybooksPreviews #
Ask an LLM
“Is there a quick preview list of playbooks for a sidebar?”
“Can I preview just my subscribed playbooks by status?”
Tell an agent
Get playbook previews filtered to status {status_filter}.
Preview only my subscribed playbooks.
POST /textql.rpc.public.playbook.PlaybookService/GetReportById Get a single report · Get a single report by ID #
Ask an LLM
“How do I open one playbook report by its ID?”
“Can I retrieve the full content of a specific report?”
Tell an agent
Get report {report_id}.
Open the full report {report_id}.
POST /textql.rpc.public.playbook.PlaybookService/GetReportsWithFilters Search reports using filters · GetReportsWithFilters #
Ask an LLM
“Can I query reports across playbooks with custom filters?”
“Which reports match a set of filter criteria?”
Tell an agent
Find reports matching filters {filters}.
Query all reports across playbooks using {filters}.
POST /textql.rpc.public.playbook.PlaybookService/ListAllSlackChannelContextPlaybooks List Slack channel context playbook mappings · List all Slack channels context playbook mappings for the organization #
Ask an LLM
“Which Slack channels in my org have a context playbook set?”
“Can I see every Slack channel to playbook mapping at once?”
Tell an agent
List all Slack channel context playbook mappings.
Show which playbook each Slack channel uses as context, timing out after {timeout_ms} ms.
POST /textql.rpc.public.playbook.PlaybookService/ListAllTeamsChannelContextPlaybooks List Teams channel context playbook mappings · ListAllTeamsChannelContextPlaybooks #
Ask an LLM
“Which Microsoft Teams channels have a context playbook assigned?”
“Can I list every Teams channel to playbook mapping in my org?”
Tell an agent
List all Teams channel context playbook mappings.
Show which playbook each Teams channel uses as context, with a {timeout_ms} ms timeout.
POST /textql.rpc.public.playbook.PlaybookService/ListPlaybookBatchRuns List a playbook's batch runs · List batch runs for a playbook #
Ask an LLM
“What batch runs has a playbook executed?”
“How many batch runs come back per page by default?”
Tell an agent
List batch runs for playbook {playbook_id}.
Show {limit} batch runs of playbook {playbook_id} starting at {offset}.
POST /textql.rpc.public.playbook.PlaybookService/ListSlackChannelsForContextPlaybook List Slack channels using a context playbook · List Slack channel IDs where the given playbook is set as the context #
Ask an LLM
“Which Slack channels use this playbook as their context?”
“Where in Slack is a given playbook set as the default context?”
Tell an agent
List the Slack channels where playbook {playbook_id} is the context.
Find Slack channel IDs tied to context playbook {playbook_id}.
POST /textql.rpc.public.playbook.PlaybookService/ListTeamsChannelsForContextPlaybook List Teams channels using a context playbook · ListTeamsChannelsForContextPlaybook #
Ask an LLM
“Which Teams channels use this playbook as context?”
“Where in Microsoft Teams is a given playbook the default context?”
Tell an agent
List the Teams channels where playbook {playbook_id} is the context.
Find Teams channel IDs tied to context playbook {playbook_id}.
POST /textql.rpc.public.playbook.PlaybookService/MarkReportAsRead Mark a report as read · Report read tracking #
Ask an LLM
“Can I clear the unread badge on a playbook report?”
“How is read tracking recorded for reports?”
Tell an agent
Mark report {report_id} as read.
Record that I've read report {report_id}.
POST /textql.rpc.public.playbook.PlaybookService/PreviewSlackReport Preview a playbook report in Slack · PreviewSlackReport #
Ask an LLM
“Can I see how a playbook's report will look when posted to Slack?”
“Is it possible to test a Slack report from a chat cell before deploying?”
Tell an agent
Preview playbook {playbook_id}'s report in Slack channel {slack_channel_id}.
Send a Slack preview of cell {cell} from chat {chat_id}.
POST /textql.rpc.public.playbook.PlaybookService/RemoveDashboard Detach a dashboard from a playbook · RemoveDashboard #
Ask an LLM
“How do I unlink a dashboard from a playbook?”
“Can a playbook stop using a dashboard without the dashboard being deleted?”
Tell an agent
Remove dashboard {dashboard_id} from playbook {playbook_id}.
Detach the dashboard {dashboard_id} from my playbook {playbook_id}.
POST /textql.rpc.public.playbook.PlaybookService/RemoveDataset Detach a dataset from a playbook · RemoveDataset #
Ask an LLM
“How do I stop a playbook from using a particular dataset?”
“Can I unlink a dataset from a playbook while keeping the dataset?”
Tell an agent
Remove dataset {dataset_id} from playbook {playbook_id}.
Detach the dataset {dataset_id} from my playbook {playbook_id}.
POST /textql.rpc.public.playbook.PlaybookService/RunPlaybook Run a playbook now · RunPlaybook #
Ask an LLM
“Can I trigger a playbook immediately instead of waiting for its schedule?”
“Is there a dry run that doesn't send notifications?”
Tell an agent
Run playbook {playbook_id} now.
Do a dry run of playbook {playbook_id} without sending notifications.
POST /textql.rpc.public.playbook.PlaybookService/SetSlackChannelContextPlaybook Set a Slack channel's context playbook · Set the context playbook for a Slack channel. #
Ask an LLM
“Can a Slack channel use a playbook's context by default?”
“How do I associate a playbook with a Slack channel?”
Tell an agent
Set playbook {playbook_id} as the context for Slack channel {slack_channel_id}.
Make Slack messages in {slack_channel_id} use playbook {playbook_id} by default.
POST /textql.rpc.public.playbook.PlaybookService/SetTeamsChannelContextPlaybook Set a Teams channel's context playbook · SetTeamsChannelContextPlaybook #
Ask an LLM
“Can a Microsoft Teams channel use a playbook as its default context?”
“What's needed to tie a playbook to a Teams channel?”
Tell an agent
Set playbook {playbook_id} as the context for Teams channel {teams_channel_id}.
Make Teams channel {teams_channel_id} answer with playbook {playbook_id}'s context.
POST /textql.rpc.public.playbook.PlaybookService/SubscribeToPlaybook Subscribe to a playbook · SubscribeToPlaybook #
Ask an LLM
“How do I follow a playbook so I get its reports?”
“Can I subscribe to someone else's playbook?”
Tell an agent
Subscribe me to playbook {playbook_id}.
Follow playbook {playbook_id} so its reports reach me.
POST /textql.rpc.public.playbook.PlaybookService/UnsetSlackChannelContextPlaybook Clear a Slack channel's context playbook · Unset the context playbook for a Slack channel. #
Ask an LLM
“How do I stop a Slack channel from using a playbook's context?”
“Can I remove the default playbook from a Slack channel?”
Tell an agent
Clear the context playbook for Slack channel {slack_channel_id}.
Unset the playbook association on Slack channel {slack_channel_id}.
POST /textql.rpc.public.playbook.PlaybookService/UnsetTeamsChannelContextPlaybook Clear a Teams channel's context playbook · UnsetTeamsChannelContextPlaybook #
Ask an LLM
“How do I stop a Teams channel from using a playbook's context?”
“Can I remove the default playbook from a Microsoft Teams channel?”
Tell an agent
Clear the context playbook for Teams channel {teams_channel_id}.
Unset the playbook association on Teams channel {teams_channel_id}.
POST /textql.rpc.public.playbook.PlaybookService/UnsubscribeFromPlaybook Unsubscribe from a playbook · UnsubscribeFromPlaybook #
Ask an LLM
“How do I stop receiving a playbook's reports?”
“Can I unfollow a playbook without affecting other subscribers?”
Tell an agent
Unsubscribe me from playbook {playbook_id}.
Stop following playbook {playbook_id}.
POST /textql.rpc.public.playbook.PlaybookService/UpdatePlaybook Update a playbook's settings · UpdatePlaybook #
Ask an LLM
“Can I change a playbook's prompt or cron schedule?”
“Which recipients, Slack or Teams channels can a playbook deliver to?”
Tell an agent
Change the prompt of playbook {playbook_id} to {prompt}.
Schedule playbook {playbook_id} with cron {cron_string}.

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-playbookservice-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-playbookservice-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-playbookservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: TextQL Playbook 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 (159 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/openapi/textql-playbookservice-api-openapi.yml