Skip to main content
POST
Add a creator

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

Headers

Idempotency-Key
string
required

Required. A new unique value per new request (8 to 64 letters, digits, - or _; a UUID is ideal). If the request times out or fails with a 5xx, retry with the SAME key: you get the original response (with Idempotent-Replayed: true) and nothing is done twice. Keys are kept for 24 hours. Without it the answer is 400 IDEMPOTENCY_KEY_REQUIRED.

Required string length: 8 - 64
Pattern: ^[A-Za-z0-9_-]{8,64}$

Body

application/json
displayName
string
required

Your team's label for her, 1 to 120 characters.

Required string length: 1 - 120
handle
string | null

Her OnlyFans username, without @ (a leading @ is ignored), up to 80 characters. Optional and only a hint: after she connects, her real username replaces it.

Maximum string length: 80
proxyCountry
string | null

Optional two-letter country code (ISO 3166-1 alpha-2) for the region OnlyX connects to OnlyFans from on her behalf. Choose the country she usually signs in from. A preference: if nothing is free there, a nearby region is used.

Pattern: ^[A-Za-z]{2}$

Response

The new creator, disconnected.

aiEnabled
boolean
required

The creator's master AI switch. false means the AI chatter answers none of her fans.

avatarUrl
string | null
required

Her OnlyFans avatar, once connected.

connection
CreatorConnection · object
required

Headline connection state. GET /v1/creators/{creatorId}/connection has the detail.

true when OnlyFans is asking her to accept its content-consent prompt; media sends fail until she does it in OnlyFans. null when not known yet.

createdAt
string
required

When the creator was added to OnlyX (ISO-8601 UTC).

displayName
string
required

Your team's label for the creator. Set by you, never changed by OnlyFans.

handle
string | null
required

Her OnlyFans username, without @. Replaced by the real username once she connects.

id
string
required

The creator id (cre_…).

onlyfans
OnlyFansProfile · object | null
required

Profile facts read from OnlyFans. null until she has connected once.

platform
enum<string>
required

Always onlyfans for creators added through the API in v1. telegram is reserved for Telegram creators, which are coming soon, so code that reads this should expect more than one value.

Available options:
onlyfans,
telegram
publicName
string | null
required

The display name on her OnlyFans profile, once connected.

stats
CreatorStats · object
required

Headline numbers, cheap to read.