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"
]
}
'import requests
url = "https://api.kataven.ai/v1/api/v1/playbooks"
payload = {
"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"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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']
})
};
fetch('https://api.kataven.ai/v1/api/v1/playbooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kataven.ai/v1/api/v1/playbooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kataven.ai/v1/api/v1/playbooks"
payload := strings.NewReader("{\n \"category\": \"customer_support\",\n \"description\": \"Verify the order, check eligibility, then issue the refund via the payment processor.\",\n \"display_name\": \"Refund Workflow\",\n \"name\": \"refund_workflow\",\n \"tags\": [\n \"refunds\",\n \"ecommerce\"\n ],\n \"tool_names\": [\n \"lookup_order\",\n \"verify_eligibility\",\n \"issue_refund\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kataven.ai/v1/api/v1/playbooks")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"category\": \"customer_support\",\n \"description\": \"Verify the order, check eligibility, then issue the refund via the payment processor.\",\n \"display_name\": \"Refund Workflow\",\n \"name\": \"refund_workflow\",\n \"tags\": [\n \"refunds\",\n \"ecommerce\"\n ],\n \"tool_names\": [\n \"lookup_order\",\n \"verify_eligibility\",\n \"issue_refund\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kataven.ai/v1/api/v1/playbooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category\": \"customer_support\",\n \"description\": \"Verify the order, check eligibility, then issue the refund via the payment processor.\",\n \"display_name\": \"Refund Workflow\",\n \"name\": \"refund_workflow\",\n \"tags\": [\n \"refunds\",\n \"ecommerce\"\n ],\n \"tool_names\": [\n \"lookup_order\",\n \"verify_eligibility\",\n \"issue_refund\"\n ]\n}"
response = http.request(request)
puts response.read_body{}"<string>""<string>"Playbooks
Create a custom playbook
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"
]
}
'import requests
url = "https://api.kataven.ai/v1/api/v1/playbooks"
payload = {
"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"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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']
})
};
fetch('https://api.kataven.ai/v1/api/v1/playbooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kataven.ai/v1/api/v1/playbooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kataven.ai/v1/api/v1/playbooks"
payload := strings.NewReader("{\n \"category\": \"customer_support\",\n \"description\": \"Verify the order, check eligibility, then issue the refund via the payment processor.\",\n \"display_name\": \"Refund Workflow\",\n \"name\": \"refund_workflow\",\n \"tags\": [\n \"refunds\",\n \"ecommerce\"\n ],\n \"tool_names\": [\n \"lookup_order\",\n \"verify_eligibility\",\n \"issue_refund\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kataven.ai/v1/api/v1/playbooks")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"category\": \"customer_support\",\n \"description\": \"Verify the order, check eligibility, then issue the refund via the payment processor.\",\n \"display_name\": \"Refund Workflow\",\n \"name\": \"refund_workflow\",\n \"tags\": [\n \"refunds\",\n \"ecommerce\"\n ],\n \"tool_names\": [\n \"lookup_order\",\n \"verify_eligibility\",\n \"issue_refund\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kataven.ai/v1/api/v1/playbooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"category\": \"customer_support\",\n \"description\": \"Verify the order, check eligibility, then issue the refund via the payment processor.\",\n \"display_name\": \"Refund Workflow\",\n \"name\": \"refund_workflow\",\n \"tags\": [\n \"refunds\",\n \"ecommerce\"\n ],\n \"tool_names\": [\n \"lookup_order\",\n \"verify_eligibility\",\n \"issue_refund\"\n ]\n}"
response = http.request(request)
puts response.read_body{}"<string>""<string>"Authorizations
Headers
Tenant database. Required when using a Zitadel JWT.
Body
application/json
Playbook spec
Playbook spec
Example:
"customer_support"
Example:
"Verify the order, check eligibility, then issue the refund via the payment processor."
Example:
"Refund Workflow"
Example:
"refund_workflow"
Example:
["refunds", "ecommerce"]
Example:
[
"lookup_order",
"verify_eligibility",
"issue_refund"
]
Response
Created

