Propose an experiment
curl -X POST https://api.xholic.ai/v1/mentor/propose-experiment \ -H "Authorization: Bearer $XHOLIC_API_KEY" \ -H "Content-Type: application/json" \ -d '{"title":"<title>","hypothesis":"<hypothesis>","dryRun":true}'xholic mentor propose-experiment --title '<title>' --hypothesis '<hypothesis>' --dry-run{ "name": "propose_experiment", "arguments": { "title": "<title>", "hypothesis": "<hypothesis>", "dryRun": true }}const response = await fetch("https://api.xholic.ai/v1/mentor/propose-experiment", { method: "POST", headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "title": "<title>", "hypothesis": "<hypothesis>", "dryRun": true }),});const result = await response.json();console.log(result.summary);import axios from "axios";
const { data } = await axios.post( "https://api.xholic.ai/v1/mentor/propose-experiment", { "title": "<title>", "hypothesis": "<hypothesis>", "dryRun": true }, { headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}` } },);console.log(data.summary);import osimport requests
response = requests.post( "https://api.xholic.ai/v1/mentor/propose-experiment", headers={"Authorization": f"Bearer {os.environ['XHOLIC_API_KEY']}"}, json={ "title": "<title>", "hypothesis": "<hypothesis>", "dryRun": True },)print(response.json()["summary"])package main
import ( "fmt" "io" "net/http" "os" "strings")
func main() { body := strings.NewReader(`{"title":"<title>","hypothesis":"<hypothesis>","dryRun":true}`) req, _ := http.NewRequest("POST", "https://api.xholic.ai/v1/mentor/propose-experiment", body) req.Header.Set("Authorization", "Bearer "+os.Getenv("XHOLIC_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(string(out))}<?php$ch = curl_init("https://api.xholic.ai/v1/mentor/propose-experiment");curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . getenv('XHOLIC_API_KEY'), 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => '{"title":"<title>","hypothesis":"<hypothesis>","dryRun":true}',]);$result = json_decode(curl_exec($ch), true);echo $result['summary'];require "net/http"require "json"
uri = URI("https://api.xholic.ai/v1/mentor/propose-experiment")req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json")req["Authorization"] = "Bearer #{ENV.fetch("XHOLIC_API_KEY")}"req.body = '{"title":"<title>","hypothesis":"<hypothesis>","dryRun":true}'res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }puts JSON.parse(res.body)["summary"]Set up a small test the user agreed to, such as ‘three proof posts with a screenshot this week beat my text posts on replies’. Xholic records the account’s baseline now and judges the result from the posts linked to it. It posts nothing. Ask the user first; set start only when they said go. For a user who wants to design the test themself, add design: the metric (including bookmarks, profile clicks or estimated follows), one group or A vs B, what to compare against (their median, group B, a format or a date range), win and lose bars, posts per group, how long posts settle and an end date. Leave design out for the usual guided test.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
What should happen and why, in one or two sentences.
The post format, such as question, one_liner, proof_numbers or list_playbook.
How many posts the test needs (default 3).
Start now (the user agreed) instead of leaving it proposed.
Optional: the user’s own design. When set, its metric and groupA format are used and posts/metric/format above are ignored.
object
What decides the test.
The posts being tested.
object
What makes this group different, e.g. ‘with a screenshot’ or ‘posted 8–9 pm’.
The post format this group uses, if the test is about format.
For an A vs B test: the other group. Then compareTo is group_b.
object
What makes this group different, e.g. ‘with a screenshot’ or ‘posted 8–9 pm’.
The post format this group uses, if the test is about format.
Posts per group before it’s judged.
Worked when group A’s median is at least this many times the comparison.
Didn’t work at or below this multiple.
Judge on this date with whatever has settled, even if fewer posts than minPosts.
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.
Return exactly what would happen without doing it.
A unique key for this write. Repeating a call with the same key returns the first result instead of acting twice.
Example
{ "title": "<title>", "hypothesis": "<hypothesis>", "dryRun": true}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" }}