TextQL Playbooks API
Create, configure, and run automated playbooks
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
Ask an LLM
“Which scheduled playbooks do I have?”
“Can I filter playbooks by status, like only deployed ones?”
Tell an agent
List my playbooks.
Show playbooks matching {search_term} with status {status}.
Ask an LLM
“How do I start a new recurring report playbook?”
“What settings does a brand-new playbook start with?”
Tell an agent
Create a new empty playbook.
Start a blank playbook with default settings.
Ask an LLM
“How do I see a playbook's configuration and its latest reports?”
“Can I page through older reports a playbook generated?”
Tell an agent
Get playbook {id}.
Show playbook {id} with its last {limit} reports.
Ask an LLM
“How do I change when a playbook runs?”
“Can a playbook send its report to email addresses and a Slack channel?”
Tell an agent
Set the prompt of playbook {id} to {prompt}.
Schedule playbook {id} on cron {cron}.
Ask an LLM
“How do I delete a playbook I no longer need?”
“Can I permanently remove a scheduled report?”
Tell an agent destructive · confirm first
Delete playbook {id}.
Remove the scheduled playbook {id}.
Ask an LLM
“How do I activate a playbook so it runs on schedule?”
“What makes a draft playbook go live?”
Tell an agent
Deploy playbook {id}.
Activate playbook {id} on its schedule.
Ask an LLM
“Can I run a playbook immediately and get the report back?”
“Is there a dry run to validate a playbook without executing it?”
Tell an agent
Run playbook {id} now.
Run playbook {id} with dry run set to {dry_run}.
Documentation
Documentation
https://docs.textql.com/api-reference/v2/introduction
APIReference
https://docs.textql.com/api-reference/v2/introduction
Authentication
https://artifacts.apis.io/textql/authentication/textql-authentication.yml
RateLimits
https://artifacts.apis.io/textql/rate-limits/textql-rate-limits.yml
Documentation
https://docs.textql.com/api-reference/introduction
APIReference
https://docs.textql.com/api-reference/introduction
Specifications
Other Resources
OAuthScopes
https://artifacts.apis.io/textql/scopes/textql-scopes.yml
ErrorCatalog
https://artifacts.apis.io/textql/errors/textql-problem-types.yml
Conventions
https://artifacts.apis.io/textql/conventions/textql-conventions.yml
DataModel
https://artifacts.apis.io/textql/data-model/textql-data-model.yml
Webhooks
https://artifacts.apis.io/textql/asyncapi/textql-webhooks.yml
Deprecation
https://artifacts.apis.io/textql/lifecycle/textql-lifecycle.yml
Conformance
https://artifacts.apis.io/textql/conformance/textql-conformance.yml