Skip to main content
POST
/
v2
/
playbooks
/
{id}
/
run
Run Playbook
curl --request POST \
  --url https://app.textql.com/v2/playbooks/{id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dry_run": false
}
'
{
  "chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "report": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "content": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "assets": [
    {
      "type": "<string>",
      "url": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.textql.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key or JWT token

Path Parameters

id
string<uuid>
required

Playbook ID

Body

application/json
dry_run
boolean
default:false

If true, validate without executing

Response

Playbook execution result

chat_id
string<uuid>
report
object
assets
object[]