Skip to main content
POST
/
api
/
v1
/
playbooks
Create a custom playbook
curl --request POST \
  --url https://api.kataven.ai/v1/api/v1/playbooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "customer_support",
  "description": "Verify the order, check eligibility, then issue the refund via the payment processor.",
  "display_name": "Refund Workflow",
  "name": "refund_workflow",
  "tags": [
    "refunds",
    "ecommerce"
  ],
  "tool_names": [
    "lookup_order",
    "verify_eligibility",
    "issue_refund"
  ]
}
'
{}

Authorizations

​
Authorization
string
header
required

Headers

​
X-Account-ID
string

Tenant database. Required when using a Zitadel JWT.

Body

application/json

Playbook spec

Playbook spec

​
category
string
Example:

"customer_support"

​
description
string
Example:

"Verify the order, check eligibility, then issue the refund via the payment processor."

​
display_name
string
Example:

"Refund Workflow"

​
name
string
Example:

"refund_workflow"

​
tags
string[]
Example:
["refunds", "ecommerce"]
​
tool_names
string[]
Example:
[
  "lookup_order",
  "verify_eligibility",
  "issue_refund"
]

Response

Created

​
{key}
string