Skip to main content
GET
Get the AI persona

Authorizations

Authorization
string
header
required

An API key (onx_sk_…) created in OnlyX under Settings → API & MCP, or an OAuth access token (onx_at_…) issued to a connected app. Send it as Authorization: Bearer <credential>. API keys may also be sent as X-API-Key: <key>.

Path Parameters

creatorId
string
required

The creator id (cre_…).

Response

The persona, its completeness, and the hand-off catalogue.

The AI persona: the brief the AI chatter follows to chat as this creator. Every field is written by your team.

accountContext
string
required

How her page works: free or paid, what is on the wall, what is sold in messages.

additionalLanguages
string[]
required

Other languages she can chat in (BCP-47 tags).

age
integer | null
required

Her age, 18 to 99. Required for the AI.

aiDisclosureEnabled
boolean
required

Whether fans are told they may be talking to an AI.

aiDisclosureText
string
required

The disclosure fans see when aiDisclosureEnabled is on.

allowTypos
boolean
required

Whether the AI may make an occasional natural typo.

archetype
string
required

Her overall character, for example girl_next_door.

boundaries
string[]
required

Topics she avoids or steers away from, in plain sentences.

capitalization
string
required

How she capitalizes: normal, all lowercase, or a casual_mix.

city
string
required

Where she says she lives. Required for the AI.

completeness
integer
required

How complete the persona is, 0 to 100.

contentMenu
string[]
required

The kinds of content she makes.

contentNotes
string
required

Anything else about her content: lengths, what is shown, what is never shown.

customContentEnabled
boolean
required

Whether the AI may quote custom content at the prices below.

customPhotoDeliveryDays
integer | null
required

Days she needs to deliver a custom photo. null uses the default of 3.

customVideoDeliveryDays
integer | null
required

Days she needs to deliver a custom video. null uses the default of 7.

emojiPolicy
string
required

How many emojis she uses: none, rare, some, heavy.

exemplars
string[]
required

Sample messages in her voice. The strongest single influence on how the AI sounds.

handoffCatalogue
HandoffKind · object[]
required

Every hand-off kind you can choose from (the example shows three of them).

handoffEffective
string[]
required

The hand-off kinds actually in force: your handoffKinds (or the recommended set) plus the locked kinds.

handoffKinds
string[] | null
required

The hand-off kinds (keys from handoffCatalogue) that make the AI hand a chat to your team. null means the recommended set; [] means only the kinds that can never be switched off.

hardLimits
string[]
required

Things she never does or offers, whatever a fan says. The AI treats them as a hard stop.

interests
string[]
required

Things she likes talking about.

lore
string
required

Her backstory in her own world: family, home, routine, personality. Required for the AI.

messageSplitting
string
required

How often one reply is split into several short messages: never, sometimes, often.

nickname
string | null
required

A pet name or short name.

occupation
string | null
required

What she does besides OnlyFans. Required for the AI.

origin
string | null
required

Where she is from.

personaName
string | null
required

The first name she uses with fans. Required for the AI.

physicalDescription
string
required

What she looks like, so the AI never contradicts her content.

priceCustomPhotoCents
integer | null
required

Minimum price for a custom photo, in cents.

priceCustomVideoMinCents
integer | null
required

Minimum total price for any custom video, in cents.

priceCustomVideoPerMinCents
integer | null
required

Minimum price per minute of custom video, in cents.

primaryLanguage
string
required

The language she chats in, as a BCP-47 tag (en, es, pt-BR).

punctuation
string
required

How carefully she punctuates: proper, relaxed or minimal.

readyForAi
boolean
required

true when every required field is filled: personaName, age, city, occupation and lore.

requiredMissing
string[]
required

Required fields that are still empty.

timezone
string
required

Her IANA time zone (America/Chicago). The AI's sense of her local time uses it.

typingSpeed
string
required

How quickly replies go out, like a person typing: fast, natural, slow.

updatedAt
string | null
required

When the persona was last changed; null if it was never written.