> ## Documentation Index > Fetch the complete documentation index at: https://help.onlyx.ai/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > You are reading OnlyX Help: the OnlyX Help Center and the OnlyX developer documentation. OnlyX is an AI chatting and CRM platform for OnlyFans agencies. Its AI chatter is called Hugo in the app. > Pages at the site root (for example /inbox/..., /hugo/..., /billing/...) are Help Center articles for agency owners, admins, chatters and creators who use the app at app.onlyx.ai. Words in bold are the exact button, menu and label names the app shows; keep them exactly as written. When these pages do not answer a question, the person can email support at support@onlyx.ai. > Pages under /developers are the developer documentation. REST API base URL: https://api.onlyx.ai/v1 (authenticate with `Authorization: Bearer `; keys start with onx_sk_ and are created in app.onlyx.ai under Settings > API & MCP). MCP server: https://mcp.onlyx.ai/mcp (OAuth, or a Bearer API key). In the API the AI chatter is `ai` on the wire. Money is integer US cents in fields ending in Cents; timestamps are UTC ISO-8601. > Rules for assistants acting on a user's behalf: discover ids with list calls and never invent them; before any call that reaches a real fan or the live OnlyFans account (sending a message, releasing a chat to the AI, turning AI on for a chat, resolving a hand-off, turning review mode off, changing the welcome message, creating a tracking link) show the user the exact content and get explicit confirmation; send every POST with an Idempotency-Key and reuse it on retry; never resend a message whose delivery status is unconfirmed; never ask a creator for her OnlyFans password or codes - she signs in herself through a connect link and the OnlyX Login app. # Get the connection status > Returns the creator's OnlyFans connection in detail: the status, OnlyX's own explanation, the `nextStep` to take, and the progress of the sync that runs after she connects. Each call checks the live connection, so poll it every 10 seconds or more while she signs in through her connect link, until `status` is `connected`; stop on `not_a_creator` or `duplicate`, which are final. When `status` is `verification`, OnlyFans wants a human check that can only be completed in app.onlyx.ai. This call is limited to one per 5 seconds per creator for each credential (`429 RATE_LIMITED` with `Retry-After`). **Scope:** requires `creators:read`. **Rate limits:** 1 call per 5 seconds per creator for each credential — on top of the general limit of 120 requests per 60 seconds per credential. ## OpenAPI ````yaml /developers/api-reference/openapi.json get /v1/creators/{creatorId}/connection openapi: 3.1.0 info: contact: email: developers@onlyx.ai name: OnlyX developers url: https://docs.onlyx.ai/ description: > The OnlyX API runs your OnlyX workspace from your own code and AI tools: creators and their connection, the fan inbox, fans, vault media, statistics, the AI chatter's setup and tracking links. **Authentication.** Send an API key as `Authorization: Bearer onx_sk_…` (create one in OnlyX under Settings → API & MCP), or an OAuth access token issued to a connected app. Keys belong to the workspace, carry scopes, and can be limited to some creators. **Conventions.** JSON with camelCase fields; timestamps are ISO-8601 UTC with a `Z`; money is integer US cents (fields end in `Cents`). Lists return `{"data": [...], "hasMore": bool, "nextCursor": string|null}` and page with `limit` and `cursor`. **Scopes.** Every operation names the scope it needs in `x-required-scope` and in its description; a credential without it gets `403 INSUFFICIENT_SCOPE`. **Errors and limits.** Errors are `{"error": {"code", "message", "requestId"}}`; every response carries `X-Request-Id`. The default limit is 120 requests per 60 seconds per credential, reported in `X-RateLimit-*` headers; over it you get `429 RATE_LIMITED` with `Retry-After`. Operations with limits of their own list them in `x-rate-limits`. **Idempotency and safety.** Every write accepts an `Idempotency-Key` header (required when sending a message, adding a creator and creating a tracking link): retry with the same key and you get the original answer instead of a second action. Operations marked `x-reaches-fans: true` can reach a real fan or change the live OnlyFans account. Guides, the MCP server and more: [docs.onlyx.ai](https://docs.onlyx.ai). summary: >- Run your OnlyX workspace (creators, inbox, fans, stats and the AI chatter) from code and AI tools. title: OnlyX API version: 1.0.0 servers: - description: Production url: https://api.onlyx.ai security: - bearerAuth: [] tags: - description: 'Who you are: the workspace and credential behind a key.' name: Workspace - description: >- The creators your workspace manages: list, read, add, rename, and the AI switch. name: Creators - description: >- Connecting a creator's OnlyFans account: connect links she opens on her own device, and the connection status to poll. name: Connect - description: >- The fan inbox: list and count conversations, read state, take over, release, and the per-chat AI switch. name: Conversations - description: Read message history and send text, free media and paid messages to fans. name: Messages - description: Conversations the AI chatter handed to your team, and resolving them. name: Hand-offs - description: >- Fans, their purchases, fan lists, and your team's notes, custom names and mute flag. name: Fans - description: >- Each creator's OnlyFans vault: media ids for messages and levels, and thumbnails. name: Media - description: >- Today, revenue, audience, the cached overview report, and each creator's transaction ledger. name: Stats - description: The brief the AI chatter follows to chat as each creator. name: AI persona - description: 'The AI content ladder: folders, ladders, priced levels and their media.' name: AI content - description: >- Follow-ups, review mode, the master AI switch, and OnlyFans' welcome message. name: AI settings - description: >- OnlyFans tracking and trial links, your cost fields, and creating new links. name: Tracking links externalDocs: description: OnlyX developer documentation url: https://docs.onlyx.ai paths: /v1/creators/{creatorId}/connection: get: tags: - Connect summary: Get the connection status description: >- Returns the creator's OnlyFans connection in detail: the status, OnlyX's own explanation, the `nextStep` to take, and the progress of the sync that runs after she connects. Each call checks the live connection, so poll it every 10 seconds or more while she signs in through her connect link, until `status` is `connected`; stop on `not_a_creator` or `duplicate`, which are final. When `status` is `verification`, OnlyFans wants a human check that can only be completed in app.onlyx.ai. This call is limited to one per 5 seconds per creator for each credential (`429 RATE_LIMITED` with `Retry-After`). **Scope:** requires `creators:read`. **Rate limits:** 1 call per 5 seconds per creator for each credential — on top of the general limit of 120 requests per 60 seconds per credential. operationId: getConnection parameters: - description: The creator id (`cre_…`). in: path name: creatorId required: true schema: description: The creator id (`cre_…`). title: Creatorid type: string responses: '200': content: application/json: example: checkedAt: '2026-09-26T10:21:07.000Z' connected: true creatorId: cre_8f2c1a9b0d7e4c3f2a1b duplicateOfCreatorId: null message: Connected. Her inbox is syncing. nextStep: none status: connected sync: phase: initial progress: 35 steps: - key: conversations label: Recent conversations status: done - key: waiting label: Fans waiting for a reply status: running - key: vault label: Vault media status: pending verificationRequired: false schema: $ref: '#/components/schemas/Connection' description: >- The connection status, OnlyX's explanation, the next step and the sync progress. headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '400': content: application/json: examples: VALIDATION_ERROR: summary: VALIDATION_ERROR value: error: code: VALIDATION_ERROR message: The request could not be read. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- The request is not valid and was not carried out. Fix it before retrying. `VALIDATION_ERROR`: the request is not valid; `message` names the field and the problem. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '401': $ref: '#/components/responses/Unauthorized' '403': content: application/json: examples: INSUFFICIENT_SCOPE: summary: INSUFFICIENT_SCOPE value: error: code: INSUFFICIENT_SCOPE message: This key does not have the `creators:read` scope. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 WORKSPACE_SUSPENDED: summary: WORKSPACE_SUSPENDED value: error: code: WORKSPACE_SUSPENDED message: This workspace is suspended. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- The credential may not do this. `INSUFFICIENT_SCOPE`: the credential lacks the `creators:read` scope (the `WWW-Authenticate` header names it; an OAuth token's message says "token" instead of "key"). `WORKSPACE_SUSPENDED`: the workspace is suspended. headers: WWW-Authenticate: $ref: '#/components/headers/WWW-Authenticate' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '404': content: application/json: examples: CREATOR_NOT_FOUND: summary: CREATOR_NOT_FOUND value: error: code: CREATOR_NOT_FOUND message: Creator not found. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- Not found. An id that does not exist, belongs to another workspace, or is outside this credential's creators all get the same answer. `CREATOR_NOT_FOUND`: no creator with this `creatorId` is visible to this credential. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '429': content: application/json: examples: RATE_LIMITED: summary: RATE_LIMITED (general limit) value: error: code: RATE_LIMITED message: Too many requests. Try again in 12 seconds. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 RATE_LIMITED_1: summary: >- RATE_LIMITED (1 call per 5 seconds per creator for each credential) value: error: code: RATE_LIMITED message: >- Check the connection at most once every 5 seconds per creator. Try again shortly. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- Over a rate limit (`RATE_LIMITED`): the general limit, or this operation's own (1 call per 5 seconds per creator for each credential). Wait `Retry-After` seconds, then retry — with the same `Idempotency-Key` for a write. headers: Retry-After: $ref: '#/components/headers/Retry-After' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '500': $ref: '#/components/responses/InternalError' components: schemas: Connection: examples: - checkedAt: '2026-09-26T10:21:07.000Z' connected: true creatorId: cre_8f2c1a9b0d7e4c3f2a1b duplicateOfCreatorId: null message: Connected. Her inbox is syncing. nextStep: none status: connected sync: phase: initial progress: 35 steps: - key: conversations label: Recent conversations status: done - key: waiting label: Fans waiting for a reply status: running - key: vault label: Vault media status: pending verificationRequired: false properties: checkedAt: description: When OnlyX checked this status (ISO-8601 UTC). type: string connected: description: '`true` only when `status` is `connected`.' type: boolean creatorId: description: The creator this status is for. type: string duplicateOfCreatorId: anyOf: - type: string - type: 'null' description: >- When `status` is `duplicate`: the creator in your workspace that already holds this OnlyFans account, if this credential can see it. Otherwise `null`. message: description: >- OnlyX's own explanation of the current status, one or two sentences for a person. type: string nextStep: description: >- What to do now. `send_connect_link`: create a connect link and send it to her. `wait`: poll again in 10 seconds or more. `complete_verification_in_app`: open the creator in app.onlyx.ai. `none`: nothing to do. `delete_and_readd`: she signed in with a fan account; delete this creator in the dashboard, add her again and ask her to sign in with her creator account. `use_duplicate`: use the creator in `duplicateOfCreatorId` and delete this copy in the dashboard. enum: - send_connect_link - wait - complete_verification_in_app - none - delete_and_readd - use_duplicate type: string status: description: >- `disconnected`: not signed in (send a connect link). `connecting`: the creator is signing in, or OnlyX is re-establishing the session. `verification`: OnlyFans asked for a human check; resolve it in app.onlyx.ai. `connected`: live. `not_a_creator`: a fan account signed in (final). `duplicate`: this OnlyFans account is already another creator in your workspace (final). enum: - disconnected - connecting - verification - connected - not_a_creator - duplicate type: string sync: $ref: '#/components/schemas/Sync' description: Progress of the sync that runs after she connects. verificationRequired: description: >- `true` when OnlyFans wants a human check on the session (`status` is `verification`). Resolve it in app.onlyx.ai; the API reports it but cannot complete it. type: boolean required: - creatorId - status - connected - verificationRequired - message - nextStep - duplicateOfCreatorId - sync - checkedAt title: Connection type: object Error: properties: error: properties: code: description: Stable, machine-readable error code. type: string message: description: What went wrong, in a sentence for a person. type: string requestId: description: >- The id of this request (also in the `X-Request-Id` header). Quote it to support. type: string required: - code - message - requestId type: object required: - error type: object Sync: properties: phase: anyOf: - enum: - initial - collections - paid_history - all_history - complete type: string - type: 'null' description: >- The sync after connecting runs in phases: `initial` (recent conversations, fans waiting for a reply, the newest vault files, recent earnings; the inbox, sending and the AI already work), `collections` (the rest of her fans, fan lists, vault and earnings), `paid_history` (older history with fans who have paid), `all_history` (older history with everyone else), then `complete` (new activity keeps syncing). `null` before the sync starts. progress: anyOf: - maximum: 100 minimum: 0 type: integer - type: 'null' description: >- Overall sync progress, 0 to 100. `null` before the first sync starts. steps: description: The steps of the current sync phase. items: $ref: '#/components/schemas/SyncStep' type: array required: - phase - progress - steps title: Sync type: object SyncStep: properties: key: description: Stable step key. type: string label: description: The step's name, for people. type: string status: description: >- The step's state: `pending`, `running`, `done`, `failed` or `skipped`. More values may be added. enum: - pending - running - done - failed - skipped type: string required: - key - label - status title: SyncStep type: object headers: X-RateLimit-Limit: description: >- Requests allowed in the current window of the tightest limit this request counted against. example: 120 schema: type: integer X-RateLimit-Remaining: description: Requests left in that window. example: 117 schema: type: integer X-RateLimit-Reset: description: When that window resets, as Unix epoch seconds. example: 1790431380 schema: type: integer X-Request-Id: description: >- The id of this request. Your own `X-Request-Id` (8 to 64 letters, digits or `-`) is echoed back; otherwise OnlyX creates one. Also in every error body as `requestId`: quote it to support. example: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: type: string WWW-Authenticate: description: >- The authentication challenge (RFC 6750), for example `Bearer error="insufficient_scope", scope="messages:send"`. schema: type: string Retry-After: description: Seconds to wait before trying again. example: 12 schema: type: integer responses: Unauthorized: content: application/json: examples: INVALID_API_KEY: summary: INVALID_API_KEY value: error: code: INVALID_API_KEY message: The API key is invalid, expired or revoked. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 INVALID_TOKEN: summary: INVALID_TOKEN value: error: code: INVALID_TOKEN message: The access token is invalid, expired or revoked. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 UNAUTHORIZED: summary: UNAUTHORIZED value: error: code: UNAUTHORIZED message: >- Authentication required. Send your API key as `Authorization: Bearer onx_sk_…`. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- No credential was sent (`UNAUTHORIZED`), or it is invalid, expired or revoked (`INVALID_API_KEY` for API keys, `INVALID_TOKEN` for OAuth access tokens: refresh the token or reconnect the app). Too many failed attempts from one address with credentials OnlyX never issued are answered `429 RATE_LIMITED` instead. headers: WWW-Authenticate: $ref: '#/components/headers/WWW-Authenticate' X-Request-Id: $ref: '#/components/headers/X-Request-Id' InternalError: content: application/json: examples: INTERNAL_ERROR: summary: INTERNAL_ERROR value: error: code: INTERNAL_ERROR message: Something went wrong on our side. requestId: req-3f9a1c2b7d4e5f60a1b2c3d4 schema: $ref: '#/components/schemas/Error' description: >- Something went wrong on OnlyX's side (`INTERNAL_ERROR`). Retry with backoff (reuse the `Idempotency-Key` for a write); quote `requestId` to support if it persists. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' securitySchemes: bearerAuth: bearerFormat: onx_sk_… API key or onx_at_… access token description: >- 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 `. API keys may also be sent as `X-API-Key: `. scheme: bearer type: http ````