Skip to content

Browse the Inspiration page

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

The app’s Inspiration page: top X posts filtered the way its controls filter them (time range, author size, minimum likes and views, verified only), sorted by all-time score, likes, views, newest or relevance, with paging. Stored data only, no X calls. For a post’s starting point by meaning, use inspiration.search instead.

q

Words to look for; leave out to browse.

string
<= 200 characters

Words to look for; leave out to browse.

timeRange
string
default: week
Allowed values: all day week month 3months year
followerRange

The author’s follower count.

string
default: all
Allowed values: all lt1k 1k-10k 10k-100k gt100k

The author’s follower count.

sortBy
string
default: allTimeScore
Allowed values: relevance allTimeScore likeCount viewCount publishedAt
minLikes
integer
default: 100 <= 9007199254740991
minViews
integer
<= 9007199254740991
verifiedOnly

Only verified authors.

boolean

Only verified authors.

cursor

NextCursor from the previous page.

string
>= 1 characters <= 2000 characters

NextCursor from the previous page.

limit
integer
default: 30 >= 1 <= 40
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"
}
}