Skip to content

Playbook for a job

GET
/playbooks/get
curl 'https://api.xholic.ai/v1/playbooks/get' \
-H "Authorization: Bearer $XHOLIC_API_KEY"

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.

id

A guide id from the list, e.g. create-worker. Leave out to list them.

string
>= 1 characters <= 80 characters

A guide id from the list, e.g. create-worker. Leave out to list them.

account

X account to act on, as @handle. Leave it out to use the connection’s default account.

string
>= 1 characters <= 64 characters

X account to act on, as @handle. Leave it out to use the connection’s default account.

Success

Media typeapplication/json
object
ok
required
boolean
summary
required

One or two readable sentences about the result.

string
data
required

The result. Its shape depends on the action.

ids
object
key
additional properties
any
next
Array<string>
creditsCharged
number
dryRun
boolean

Example

{
"ok": true
}

Error

Media typeapplication/json
object
ok
required
boolean
error
required
object
code
required
string
Allowed values: UNAUTHENTICATED INVALID_CREDENTIAL SCOPE_MISSING ROLE_NOT_PERMITTED ACCOUNT_NOT_FOUND SUBSCRIPTION_REQUIRED FEATURE_NOT_INCLUDED APP_ONLY INVALID_INPUT NOT_FOUND CONFLICT CREDITS_CONFIRMATION_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED IDEMPOTENCY_KEY_REUSED IDEMPOTENCY_IN_PROGRESS X_DATA_LIMIT_REACHED ACCOUNT_ON_HOLD UPSTREAM_UNAVAILABLE MAINTENANCE INCIDENT INTERNAL_ERROR
message
required
string
scope
required
string
Allowed values: account platform
retryAfterSeconds
integer
details

Example

{
"ok": false,
"error": {
"code": "UNAUTHENTICATED",
"scope": "account"
}
}