Skip to content

Update an experiment

POST
/mentor/update-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}'

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.

Media typeapplication/json
object
experimentId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
string
Allowed values: RUNNING DONE DROPPED
scheduledPostId

A queued post id from schedule_post.

string
>= 1 characters <= 100 characters
tweetId

The X post id.

string
/^\d{6,30}$/
group

For a designed A vs B test: which group the linked post belongs to (default a).

string
Allowed values: a b
unlinkScheduledPostId

Unlink this queued post from the experiment.

string
>= 1 characters <= 100 characters
unlinkTweetId

Unlink this posted tweet from the experiment.

string
/^\d{6,30}$/
title
string
>= 5 characters <= 160 characters
hypothesis
string
>= 10 characters <= 500 characters
design

Replace the design; only while the experiment is proposed.

object
metric
required

What decides the test.

string
Allowed values: impressions replies bookmarks engagement profile_clicks follows
groupA
required

The posts being tested.

object
label
required

What makes this group different, e.g. ‘with a screenshot’ or ‘posted 8–9 pm’.

string
>= 2 characters <= 80 characters
format

The post format this group uses, if the test is about format.

string
Allowed values: relatable_scene one_liner contrast_pair hot_take contrarian_reframe personal_story proof_numbers build_update list_playbook framework question observation trend_reaction ironic_humor advice motivation networking promotion other
groupB

For an A vs B test: the other group. Then compareTo is group_b.

object
label
required

What makes this group different, e.g. ‘with a screenshot’ or ‘posted 8–9 pm’.

string
>= 2 characters <= 80 characters
format

The post format this group uses, if the test is about format.

string
Allowed values: relatable_scene one_liner contrast_pair hot_take contrarian_reframe personal_story proof_numbers build_update list_playbook framework question observation trend_reaction ironic_humor advice motivation networking promotion other
compareTo
One of:
object
kind
required
string
Allowed values: own_median
days
integer
default: 30 >= 7 <= 90
minPosts

Posts per group before it’s judged.

integer
default: 3 >= 2 <= 20
winAt

Worked when group A’s median is at least this many times the comparison.

number
default: 1.2 >= 1.05 <= 10
loseAt

Didn’t work at or below this multiple.

number
default: 0.8 >= 0.1 <= 0.95
settleHours
Any of:
number
Allowed values: 24
endsAt

Judge on this date with whatever has settled, even if fewer posts than minPosts.

string
/^\d{4}-\d{2}-\d{2}$/
account

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

string
>= 1 characters <= 64 characters
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
dryRun

Return exactly what would happen without doing it.

boolean
idempotencyKey

A unique key for this write. Repeating a call with the same key returns the first result instead of acting twice.

string
>= 8 characters <= 200 characters

Example

{
"experimentId": "<experimentId>",
"dryRun": true
}

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