# TextQL Playbook Service API **Canonical:** https://apis.io/apis/textql/textql-playbookservice-api/ **Provider:** TextQL — https://apis.io/providers/textql/ **Base URL:** https://app.textql.com/v2 **Documentation:** https://docs.textql.com/api-reference/v2/introduction TextQL Playbook Service API is one of 39 APIs that [TextQL](https://apis.io/providers/textql/) publishes on the [APIs.io](https://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. The PlaybookService API from TextQL — 39 operation(s) for playbookservice. ## Operations (39) | Method | Path | Summary | |---|---|---| | POST | `/textql.rpc.public.playbook.PlaybookService/AttachDashboard` | AttachDashboard | | POST | `/textql.rpc.public.playbook.PlaybookService/AttachDataset` | AttachDataset | | POST | `/textql.rpc.public.playbook.PlaybookService/CancelTemplateExecution` | Cancel template execution for a specific template header | | POST | `/textql.rpc.public.playbook.PlaybookService/CreatePlaybook` | CreatePlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/DeactivatePlaybook` | DeactivatePlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/DeletePlaybook` | DeletePlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/DemoPlaybook` | DemoPlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/DeployPlaybook` | DeployPlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/DuplicatePlaybook` | DuplicatePlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/FavoriteReport` | Favorite report management | | POST | `/textql.rpc.public.playbook.PlaybookService/GetActiveSubscribedPlaybooksCount` | GetActiveSubscribedPlaybooksCount | | POST | `/textql.rpc.public.playbook.PlaybookService/GetChatReportsSummary` | Lightweight endpoint for chat report drawer - returns summaries without full… | | POST | `/textql.rpc.public.playbook.PlaybookService/GetMembersWithPlaybooks` | GetMembersWithPlaybooks | | POST | `/textql.rpc.public.playbook.PlaybookService/GetPlaybook` | GetPlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/GetPlaybookBatchRun` | Get a specific batch run | | POST | `/textql.rpc.public.playbook.PlaybookService/GetPlaybookLineage` | GetPlaybookLineage | | POST | `/textql.rpc.public.playbook.PlaybookService/GetPlaybookReports` | GetPlaybookReports | | POST | `/textql.rpc.public.playbook.PlaybookService/GetPlaybookReportsBatch` | Get reports for multiple template data IDs in a single batch request | | POST | `/textql.rpc.public.playbook.PlaybookService/GetPlaybooks` | GetPlaybooks | | POST | `/textql.rpc.public.playbook.PlaybookService/GetPlaybooksPreviews` | GetPlaybooksPreviews | | POST | `/textql.rpc.public.playbook.PlaybookService/GetReportById` | Get a single report by ID | | POST | `/textql.rpc.public.playbook.PlaybookService/GetReportsWithFilters` | GetReportsWithFilters | | POST | `/textql.rpc.public.playbook.PlaybookService/ListAllSlackChannelContextPlaybooks` | List all Slack channels context playbook mappings for the organization | | POST | `/textql.rpc.public.playbook.PlaybookService/ListAllTeamsChannelContextPlaybooks` | ListAllTeamsChannelContextPlaybooks | | POST | `/textql.rpc.public.playbook.PlaybookService/ListPlaybookBatchRuns` | List batch runs for a playbook | | POST | `/textql.rpc.public.playbook.PlaybookService/ListSlackChannelsForContextPlaybook` | List Slack channel IDs where the given playbook is set as the context | | POST | `/textql.rpc.public.playbook.PlaybookService/ListTeamsChannelsForContextPlaybook` | ListTeamsChannelsForContextPlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/MarkReportAsRead` | Report read tracking | | POST | `/textql.rpc.public.playbook.PlaybookService/PreviewSlackReport` | PreviewSlackReport | | POST | `/textql.rpc.public.playbook.PlaybookService/RemoveDashboard` | RemoveDashboard | | POST | `/textql.rpc.public.playbook.PlaybookService/RemoveDataset` | RemoveDataset | | POST | `/textql.rpc.public.playbook.PlaybookService/RunPlaybook` | RunPlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/SetSlackChannelContextPlaybook` | Set the context playbook for a Slack channel. | | POST | `/textql.rpc.public.playbook.PlaybookService/SetTeamsChannelContextPlaybook` | SetTeamsChannelContextPlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/SubscribeToPlaybook` | SubscribeToPlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/UnsetSlackChannelContextPlaybook` | Unset the context playbook for a Slack channel. | | POST | `/textql.rpc.public.playbook.PlaybookService/UnsetTeamsChannelContextPlaybook` | UnsetTeamsChannelContextPlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/UnsubscribeFromPlaybook` | UnsubscribeFromPlaybook | | POST | `/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook` | UpdatePlaybook | ## Machine-readable artifacts (14) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/openapi/textql-playbookservice-api-openapi.yml - **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 - **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 - **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 - **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 ## Other TextQL APIs (12) - [Ana MCP Server](https://apis.io/apis/textql/textql-ana-mcp-server/) - [TextQL Agent Service API](https://apis.io/apis/textql/textql-agentservice-api/) - [TextQL API Keys API](https://apis.io/apis/textql/textql-api-keys-api/) - [TextQL App Service API](https://apis.io/apis/textql/textql-appservice-api/) - [TextQL Audit Log Service API](https://apis.io/apis/textql/textql-auditlogservice-api/) - [TextQL Changes API](https://apis.io/apis/textql/textql-changes-api/) - [TextQL Chat API](https://apis.io/apis/textql/textql-chat-api/) - [TextQL Chat Service API](https://apis.io/apis/textql/textql-chatservice-api/) - [TextQL Connectors API](https://apis.io/apis/textql/textql-connectors-api/) - [TextQL Connector Service API](https://apis.io/apis/textql/textql-connectorservice-api/) - [TextQL Dashboard Service API](https://apis.io/apis/textql/textql-dashboardservice-api/) - [TextQL Dataset Service API](https://apis.io/apis/textql/textql-datasetservice-api/) ## Tags PlaybookService --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/textql/textql-playbookservice-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/textql/.