Playbook for a job
curl 'https://api.xholic.ai/v1/playbooks/get' \ -H "Authorization: Bearer $XHOLIC_API_KEY"xholic playbooks get{ "name": "get_playbook", "arguments": {}}const response = await fetch("https://api.xholic.ai/v1/playbooks/get", { headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}` },});const result = await response.json();console.log(result.summary);import axios from "axios";
const { data } = await axios.get("https://api.xholic.ai/v1/playbooks/get", { params: {}, headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}` },});console.log(data.summary);import osimport requests
response = requests.get( "https://api.xholic.ai/v1/playbooks/get", headers={"Authorization": f"Bearer {os.environ['XHOLIC_API_KEY']}"}, params={},)print(response.json()["summary"])package main
import ( "fmt" "io" "net/http" "os")
func main() { req, _ := http.NewRequest("GET", "https://api.xholic.ai/v1/playbooks/get", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("XHOLIC_API_KEY")) res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body))}<?php$ch = curl_init("https://api.xholic.ai/v1/playbooks/get");curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('XHOLIC_API_KEY')],]);$result = json_decode(curl_exec($ch), true);echo $result['summary'];require "net/http"require "json"
uri = URI("https://api.xholic.ai/v1/playbooks/get")req = Net::HTTP::Get.new(uri)req["Authorization"] = "Bearer #{ENV.fetch("XHOLIC_API_KEY")}"res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }puts JSON.parse(res.body)["summary"]Step-by-step guides for multi-step jobs, the same ones Xholic’s own assistant follows: create a Worker or a Signals agent, find customers, a weekly recap, a post-mortem, a week of posts, a thread, a reply session and more. Call it first when a request is one of these jobs, then follow the guide: it says what to look up, which questions to ask (with your recommendation first) and when to wait for the user’s yes. Without id it lists every guide with when to use it, plus the user’s own saved routines; with id it returns one guide. Free: you do the work.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”A guide id from the list, e.g. create-worker. Leave out to list them.
A guide id from the list, e.g. create-worker. Leave out to list them.
X account to act on, as @handle. Leave it out to use the connection’s default account.
X account to act on, as @handle. Leave it out to use the connection’s default account.
Responses
Section titled “Responses”Success
object
One or two readable sentences about the result.
The result. Its shape depends on the action.
object
Example
{ "ok": true}default
Section titled “default”Error
object
object
Example
{ "ok": false, "error": { "code": "UNAUTHENTICATED", "scope": "account" }}