Skip to content

Growth brief

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

Call it once at the start of every session with this account. For an AI client it opens with session: the goal’s pace, what happened since the last session, test results, contradictions between the plan and the account’s own results, the next move and up to 2 questions worth asking (askUser). Answer first, pick up from continueFrom, raise the one most important item, ask at most 2 of askUser’s questions (save answers with answer_question), propose goals and tests as questions, pass a note on a call when the user decides something, end with 2–4 next steps, and log_check_in at the end. Then the growth brief, kept current by Xholic from stored data: where it stands (followers, reach, cadence, reply payoff), its main bottleneck with the evidence, the next moves, running experiments, what X’s algorithm changed lately, a 4-week trend of the account’s posts, whatChanged (what Xholic noticed moving, with possible causes to check) and lastCheckIn (what was advised last time and how the account did since). It is Xholic’s read, a starting point: check it against get_account_data and your own knowledge of X before advising. As the account’s growth mentor: start with whatChanged, follow up on lastCheckIn (what was advised and how the account did since), check the raw data before advising, end with three to five follow-up questions the user can ask next, and save your diagnosis and advice with log_check_in. It may include pendingJobs: small pieces of thinking Xholic would like your model to do. Do them if you can and send each with submit_work; if you skip them Xholic does them itself later.

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.

note

Optional, on any tool: one or two sentences for Xholic’s shared memory about what the user just decided, asked for or said about themselves or their plans (e.g. “Dropping threads for now; focusing on replies to founders”). Every AI the user connects reads it, so they never repeat themselves. In your words, never other people’s posts. Leave it out when nothing new was said.

string
<= 20000 characters

Optional, on any tool: one or two sentences for Xholic’s shared memory about what the user just decided, asked for or said about themselves or their plans (e.g. “Dropping threads for now; focusing on replies to founders”). Every AI the user connects reads it, so they never repeat themselves. In your words, never other people’s posts. Leave it out when nothing new was said.

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"
}
}