Growth brief
curl 'https://api.xholic.ai/v1/mentor/brief' \ -H "Authorization: Bearer $XHOLIC_API_KEY"xholic mentor brief{ "name": "get_brief", "arguments": {}}const response = await fetch("https://api.xholic.ai/v1/mentor/brief", { 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/mentor/brief", { params: {}, headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}` },});console.log(data.summary);import osimport requests
response = requests.get( "https://api.xholic.ai/v1/mentor/brief", 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/mentor/brief", 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/mentor/brief");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/mentor/brief")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"]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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”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.
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.
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.
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" }}