platform says which kind she is: onlyfans or telegram. Code that reads it must expect both.
- OnlyFans creators can be added and connected through the API: see Add a creator.
- Telegram creators are added and connected in the dashboard only, with a managed Telegram account or her own number, never with a link.
GET /v1/creatorslists them, butPOST /v1/creatorsadds only OnlyFans creators, and a connect link for a Telegram creator is refused with409 CREATOR_NOT_CONNECTABLE. For a Telegram creator,publicNameandonlyfansare alwaysnull. How they differ for your team is in the Help Center’s Telegram creators section.
The Creator object
GET /v1/creators lists them, oldest first (page with limit, up to 100, and cursor; a key limited to some creators lists only those). GET /v1/creators/{creatorId} returns one (plus readiness checks); an id from another workspace, or one the key may not see, is 404 CREATOR_NOT_FOUND, exactly like an id that does not exist.
Creator
Connection status
connection.status is one of six values. GET /v1/creators/{creatorId}/connection returns the detailed view, including what to do next. The dashboard shows the same six states with its own words, which are the ones your team will use:
connection.connected is true only for connected. Build your logic on status, not on the boolean.
The status does not say how she connected. There are three ways, and only one of them starts from the API:
- Connect with App: she signs herself in with the OnlyX Login app on her iPhone, Mac or Windows computer, from the setup link that
POST /v1/creators/{creatorId}/connect-linkreturns (the same link as the dashboard’s Copy setup link). - Connect here: someone on your team signs her in, in a browser streamed into the dashboard. It cannot pass OnlyFans’ face check.
- Connect with proxy: her phone joins the account’s network through the Happ app, your team signs her in from the dashboard, and she finishes the face check on her phone.
Telegram creators
A Telegram creator’sconnection.status is only ever connected, connecting (her Telegram session exists but is offline) or disconnected (no account connected, or Telegram needs a person). sync is always empty, and message and nextStep are worded for OnlyFans: for a Telegram creator, send_connect_link means “connect or reconnect her Telegram account in the dashboard”, because a connect link is refused.
The AI switch: aiEnabled
aiEnabled turns Hugo, the AI chatter, on or off for everything of this creator at once:
- Off: the AI stops answering her fans, sends no follow-ups, and new conversations start with your team (
team). Your team and the API can still read and send. - On: the AI answers conversations whose status is
ai, subject to per-chat settings. Turning it on reaches real fans: the AI starts answering every fan waiting in her AI chats, usually within seconds, so confirm with a person first.
PATCH /v1/creators/{creatorId} and {"aiEnabled": false} (scope creators:write). There is no timer: a paused creator stays paused until someone turns the AI back on. To pause the AI in a single chat instead, see Conversations.
Readiness
GET /v1/creators/{creatorId} adds a readiness block: whether the creator is set up well enough for the AI to chat and sell, and what is missing.
label and hint are display text for people (hint is null when the check passes); branch on key and ok. More checks may be added, so treat an unknown key like any other check. ready is true only when every check passes.
A Telegram creator gets the same five checks. The two setup steps only Telegram creators have in the dashboard, her Stripe keys on Payments and her files on Media, are not in this list, and she cannot sell until both are done, so confirm them in the dashboard.
What you can change through the API
connection.status is never writable: only a real sign-in changes it, and a PATCH that sends it (or any field other than displayName and aiEnabled) is refused with 400 VALIDATION_ERROR. Deleting and disconnecting a creator are done in the dashboard in v1.
Related
- Add a creator: connect a new account end to end.
- Hugo, the AI chatter: what the AI does for a creator.
- Pull stats: per-creator and workspace reports.
- Help Center: Connecting OnlyFans accounts, For creators and Telegram creators.