Skip to content

Open in Xholic

GET
/app/link
curl 'https://api.xholic.ai/v1/app/link?page=home' \
-H "Authorization: Bearer $XHOLIC_API_KEY"

A link that opens a page of the Xholic app on the chosen X account, for when the user wants to see something themselves: the queue or one post, drafts, analytics, the DM inbox or a campaign, contacts or a list, Signals, Workers, an article, an Ask chat, settings, billing or plans. connect_account opens the X accounts dialog (connect, switch or remove accounts), sharing opens account sharing, and security opens signed-in sessions; the user finishes those there. Pass account to open it as another connected account.

page
required
string
Allowed values: home queue drafts analytics inbox dm_campaign contacts signals workers inspiration saved engage ask article settings billing plans developers connect_account sharing security

Example

home
id

The item to open: a post id (queue), campaign id, list id (contacts), article id or Ask chat id.

string
>= 1 characters <= 191 characters

The item to open: a post id (queue), campaign id, list id (contacts), article id or Ask chat id.

tab

For settings: which tab.

string
Allowed values: general context memory billing developers

For settings: which tab.

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