Update an experiment
curl -X POST https://api.xholic.ai/v1/mentor/update-experiment \ -H "Authorization: Bearer $XHOLIC_API_KEY" \ -H "Content-Type: application/json" \ -d '{"experimentId":"<experimentId>","dryRun":true}'xholic mentor update-experiment --experiment-id '<experimentId>' --dry-run{ "name": "update_experiment", "arguments": { "experimentId": "<experimentId>", "dryRun": true }}const response = await fetch("https://api.xholic.ai/v1/mentor/update-experiment", { method: "POST", headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "experimentId": "<experimentId>", "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/update-experiment", { "experimentId": "<experimentId>", "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/update-experiment", headers={"Authorization": f"Bearer {os.environ['XHOLIC_API_KEY']}"}, json={ "experimentId": "<experimentId>", "dryRun": True },)print(response.json()["summary"])package main
import ( "fmt" "io" "net/http" "os" "strings")
func main() { body := strings.NewReader(`{"experimentId":"<experimentId>","dryRun":true}`) req, _ := http.NewRequest("POST", "https://api.xholic.ai/v1/mentor/update-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/update-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 => '{"experimentId":"<experimentId>","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/update-experiment")req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json")req["Authorization"] = "Bearer #{ENV.fetch("XHOLIC_API_KEY")}"req.body = '{"experimentId":"<experimentId>","dryRun":true}'res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }puts JSON.parse(res.body)["summary"]Start, finish or drop an experiment, or link a scheduled or posted post to it so its numbers count (schedule the post first, then link it here with its id, or with the tweet id once it’s out). Also: put a linked post in group A or B (group), unlink a post linked by mistake, edit the title or hypothesis, or change the design while the experiment is still proposed.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
A queued post id from schedule_post.
The X post id.
For a designed A vs B test: which group the linked post belongs to (default a).
Unlink this queued post from the experiment.
Unlink this posted tweet from the experiment.
Replace the design; only while the experiment is proposed.
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
{ "experimentId": "<experimentId>", "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" }}