Skip to content

This week's plan

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

When the user asks what to post (this week or today), start here. The account’s plan for this week, built by Xholic from its goal, sub-topics, results and what’s moving in its circle. Its mode says what the week explores for the account’s stage (new accounts test new lanes, then formats inside proven lanes, then hooks, then small bets) in one line to pass on. Each slot has a day and time, a sub-topic, a mechanism, a format, where the idea comes from, the draft text (or what to write), its status and why it was chosen; plus the week’s test (its slots are marked; a lanes test tries new sub-topics, one or two posts each), one wild card, and the trial lanes with how each is doing. Built on first read if missing. Also cleanup (stale drafts and overdue notes to remove or use) and goalMismatch (when the plan’s posts a day differ from the goal’s). Pass today: true for just today’s slots. Nothing is scheduled until the user approves a slot with approve_plan_slot.

today

Only today’s slots, in the account’s timezone.

boolean

Only today’s slots, in the account’s timezone.

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