Skip to content

Save a note

POST
/notes/add
curl -X POST https://api.xholic.ai/v1/notes/add \
-H "Authorization: Bearer $XHOLIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"<title>","dryRun":true}'

Save a note to the account’s Xholic memory: something to post later (“something like this Thursday”), a plan, a test to run (“try 4 threads vs 4 single posts”), a finding, or work another agent finished that is worth posting about. Xholic adds the numbers of any linked posts, turns a due or triggered note into drafts the user approves, and writes the result back once a post made from it settles. Save only what the user asked for or clearly intends; never notes “just in case”. Not for lasting facts or preferences about the user: use remember for those.

Media typeapplication/json
object
title
required

One line: what to do or what was found.

string
>= 1 characters <= 140 characters
body

Details, the user’s words, the analysis.

string
<= 4000 characters
kind

IDEA (default), PLAN, TEST, FINDING or HANDOFF.

string
Allowed values: IDEA PLAN TEST FINDING HANDOFF
due

When to act: a date such as 2026-10-30, a local date and time such as 2026-10-30T09:00 (then pass timezone), or an ISO time with offset.

string
>= 1 characters <= 40 characters
timezone

IANA timezone for due, such as Asia/Kolkata.

string
>= 1 characters <= 80 characters
trigger
One of:
object
type
required
string
Allowed values: OWN_SPIKE
posts

X post URLs or ids the note is about. Xholic adds their numbers and why they worked.

Array<string>
<= 20 items
handles

X accounts the note is about.

Array<string>
<= 20 items
format

The post format, such as question, one_liner, proof_numbers or list_playbook.

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

{
"title": "<title>",
"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"
}
}