TextQL

TextQL Textql.rpc.platform.Playbook Service API

Platform Playbook Service - External API for playbook management

GitHub OpenAPI

Operations 7

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 /v1/playbooks/create Create a playbook via the platform API · CreatePlaybook #
Ask an LLM
“How do I create a playbook through the v1 platform endpoint?”
“Can I start an empty playbook programmatically?”
Tell an agent
Create a new playbook through the platform API.
Create a blank playbook, waiting up to {timeout_ms} ms.
POST /v1/playbooks/delete Delete a playbook · DeletePlaybook #
Ask an LLM
“How do I delete a playbook using the platform API?”
“Is a deleted playbook gone for good?”
Tell an agent destructive · confirm first
Delete playbook {playbook_id}.
Permanently remove playbook {playbook_id}.
POST /v1/playbooks/deploy Deploy a playbook · DeployPlaybook #
Ask an LLM
“How do I take a playbook live from the platform API?”
“What makes a draft playbook start running?”
Tell an agent
Deploy playbook {playbook_id}.
Put playbook {playbook_id} into production.
POST /v1/playbooks/get Get a playbook's details · GetPlaybook #
Ask an LLM
“What's configured on one playbook?”
“Can I page through a playbook's entries?”
Tell an agent
Get playbook {playbook_id}.
Fetch playbook {playbook_id} with {limit} entries from offset {offset}.
POST /v1/playbooks/list List and search playbooks · ListPlaybooks #
Ask an LLM
“Which playbooks exist in my organization?”
“Can I search playbooks by name and filter by status?”
Tell an agent
List my playbooks.
Search playbooks for {search_term} with status {status_filter}.
POST /v1/playbooks/run Run a playbook now · RunPlaybook #
Ask an LLM
“Can I trigger a playbook on demand?”
“Is a dry run possible before a real playbook run?”
Tell an agent
Run playbook {playbook_id} now.
Dry-run playbook {playbook_id} with template {template_id}.
POST /v1/playbooks/update Update a playbook · UpdatePlaybook #
Ask an LLM
“Can I change a playbook's prompt, schedule or model?”
“How do I change where a playbook's reports are emailed?”
Tell an agent
Set playbook {playbook_id}'s prompt to {prompt}.
Run playbook {playbook_id} on 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-textql-rpc-platform-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-textql-rpc-platform-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-textql-rpc-platform-playbookservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Textql.rpc.platform.Playbook Service API
  version: '1.0'
  description: Platform Playbook Service - External API for playbook management
security: []
tags:


# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/openapi/textql-textql-rpc-platform-playbookservice-api-openapi.yml