# Substy Developers: API v1 > Public API and MCP integration documentation. Read the relevant guide and endpoint schema before calling the platform. API base URL: https://api-dev.substy.ai OpenAPI specification: https://docs-dev.substy.ai/v1/openapi.json ## Guides - [Get API access](https://docs-dev.substy.ai/docs/v1/api-access.md): Check agency access, create a personal API key, and connect your application. - [Authentication](https://docs-dev.substy.ai/docs/v1/authentication.md): Use Clerk API keys issued by Substy for one agency at a time. - [Build with AI](https://docs-dev.substy.ai/docs/v1/build-with-ai.md): Give your AI assistant the Substy documentation before building an integration. - [Errors](https://docs-dev.substy.ai/docs/v1/errors.md): Diagnose failed requests and decide when a retry is appropriate. - [Build with Substy](https://docs-dev.substy.ai/docs/v1.md): Connect your agency’s workflows, data, and tools through one API. - [API and MCP](https://docs-dev.substy.ai/docs/v1/mcp.md): Connect Claude, Claude Code, or Codex to your Substy agency. - [Writes and operation receipts](https://docs-dev.substy.ai/docs/v1/operations.md): Look up the recorded outcome of an API action when you have its operation identifier. - [Agencies and permissions](https://docs-dev.substy.ai/docs/v1/permissions.md): Limit access by agency, category, role, and creator. - [Make your first request](https://docs-dev.substy.ai/docs/v1/quickstart.md): From an agency API key to your first creator list. - [Rate limits](https://docs-dev.substy.ai/docs/v1/rate-limits.md): API and MCP traffic share one request budget per agency. - [Requests and pagination](https://docs-dev.substy.ai/docs/v1/requests.md): Send ordinary JSON requests and follow each endpoint’s pagination contract. - [Conversation webhooks](https://docs-dev.substy.ai/docs/v1/webhooks.md): Receive handoffs, AI status changes, blocked conversations, message sends and custom order changes without polling conversations. ## Endpoint reference - [Get creator customs settings](https://docs-dev.substy.ai/reference/v1/creators/get_creator_customs_settings.md): Read a creator’s customs activation, free-form instructions, minimum price, price per minute and currency. - [Update creator customs settings](https://docs-dev.substy.ai/reference/v1/creators/update_creator_customs_settings.md): Save a creator’s customs policy and prices. Enabling sales requires nonempty free-form instructions. Disabling new sales preserves existing orders. - [List custom orders](https://docs-dev.substy.ai/reference/v1/creators/list_custom_orders.md): List up to 100 custom orders for one creator, filtered by one or several statuses, a fan, a search on the request and fan name, or work to do (to_deliver, or overdue against the given calendar day), sorted newest, oldest or by closest deadline (orders without one last). Follow nextCursor with the same filters and sort for later pages; total counts every match on the first page and is null on later pages. Includes payment totals and the latest ten event receipts per order. - [Get custom order](https://docs-dev.substy.ai/reference/v1/creators/get_custom_order.md): Read one creator-scoped custom order, payment totals, deadline and the latest ten event receipts. Inspect sentAt, skippedAt, failedAt and lastError to distinguish confirmed sends, actions settled without a fan message (the AI may not write to the fan) and queued or failed actions. - [Set custom order deadline](https://docs-dev.substy.ai/reference/v1/creators/set_custom_order_deadline.md): Register an ETA of 1–365 days for a fully paid custom order. Returns an asynchronous event receipt; refresh the order to confirm processing and the fan notification. - [Deliver custom order](https://docs-dev.substy.ai/reference/v1/creators/deliver_custom_order.md): Queue fulfillment of a fully paid custom order with 1–20 unique media IDs belonging to its creator and matching its format. Media is sent without a second charge. Repeating the action returns the same receipt while it is queued or sent; after a failed send it registers a new attempt. Refresh the order to verify platform-confirmed delivery or failure. - [Retry custom order delivery](https://docs-dev.substy.ai/reference/v1/creators/retry_custom_order_delivery.md): Send a custom order delivery again after its last attempt failed, with the same media. Returns the new attempt’s receipt (retryNumber counts the retries); fails when no delivery failed. Refresh the order to verify platform-confirmed delivery. - [List conversation webhooks](https://docs-dev.substy.ai/reference/v1/creators/list_conversation_webhooks.md): List this API connection’s webhook for one creator, without its signing secret. - [Create conversation webhook](https://docs-dev.substy.ai/reference/v1/creators/create_conversation_webhook.md): Register an HTTPS webhook for one creator. Select handoff, AI status changed, AI blocked changed, message sent and custom order created, updated or finalized events. Finalized means platform-confirmed custom delivery. Save the returned signing secret; only one webhook per creator and API connection is allowed. - [Delete conversation webhook](https://docs-dev.substy.ai/reference/v1/creators/delete_conversation_webhook.md): Delete this API connection’s webhook and its pending deliveries. A delivery already in flight may still arrive. - [List accessible creators](https://docs-dev.substy.ai/reference/v1/creators/list_accessible_creators.md): List connected creator accounts accessible to the current account, optionally filtering pending connections and including settings. - [Get creator account](https://docs-dev.substy.ai/reference/v1/creators/get_creator_account.md): Read one connected creator account and its available Substy settings. Stored platform authentication details are excluded. - [List creator subscribers](https://docs-dev.substy.ai/reference/v1/creators/list_creator_subscribers.md): List a creator's subscribers with optional online and text-search filters. Use offset and limit to request additional pages. - [Update creator account](https://docs-dev.substy.ai/reference/v1/creators/update_creator_account.md): Update the supplied creator account fields in Substy. Use update_creator_platform_profile to change public profile fields on the platform. - [Delete creator account](https://docs-dev.substy.ai/reference/v1/creators/delete_creator_account.md): Remove the connected creator account from the current agency. - [List creator tagged users](https://docs-dev.substy.ai/reference/v1/creators/list_creator_tagged_users.md): List platform accounts tagged or associated with the creator's content. Use the returned identifiers when tagging participants in supported content; continue using nextCursor for more accounts. - [Get creator platform users](https://docs-dev.substy.ai/reference/v1/creators/get_creator_platform_users.md): Look up up to 100 platform user IDs in the context of the creator account. - [Get mcp rate limits](https://docs-dev.substy.ai/reference/v1/api-essentials/get_mcp_rate_limits.md): Read the agency plan tier, live rolling usage, active calls, calls per minute and concurrent-call limit. MCP calls are free with no monthly quota; platform actions retain their ordinary charges. - [Read a server operation receipt](https://docs-dev.substy.ai/reference/v1/api-essentials/get_operation.md): Access is rechecked before returning saved results. RUNNING and UNKNOWN outcomes must not be blindly repeated. - [Search Substy documentation](https://docs-dev.substy.ai/reference/v1/api-essentials/search_documentation.md): - [Check whether this process is running](https://docs-dev.substy.ai/reference/v1/api-essentials/get_liveness.md): - [Check whether the service can accept requests](https://docs-dev.substy.ai/reference/v1/api-essentials/get_readiness.md): - [Read the OpenAPI specification](https://docs-dev.substy.ai/reference/v1/api-essentials/get_api_specification.md): - [Get my agency access](https://docs-dev.substy.ai/reference/v1/account-and-agency/get_my_agency_access.md): Read the signed-in account, current agency role, permission keys and accessible creators. Use this to understand which platform actions the connected account can perform. - [Get agency access](https://docs-dev.substy.ai/reference/v1/account-and-agency/get_agency_access.md): Read the connected account's role, permissions and creator scope for the requested agency. The agency must match the approved MCP agency. - [Get creator platform profile](https://docs-dev.substy.ai/reference/v1/account-and-agency/get_creator_platform_profile.md): Read the creator's public profile and editable profile settings from the connected platform. - [Update creator platform profile](https://docs-dev.substy.ai/reference/v1/account-and-agency/update_creator_platform_profile.md): Change the creator's supported public profile fields on the connected platform. - [Get creator platform details](https://docs-dev.substy.ai/reference/v1/account-and-agency/get_creator_platform_details.md): Read the connected platform's account details for a creator. Stored authentication credentials are excluded. - [Get agency settings](https://docs-dev.substy.ai/reference/v1/account-and-agency/get_agency_settings.md): Read the current agency's Substy record and available administration settings. - [Get my employee record by id](https://docs-dev.substy.ai/reference/v1/account-and-agency/get_my_employee_record_by_id.md): Read the signed-in account's employee record using its own user ID. This operation cannot read another employee's record. - [Get my employee record](https://docs-dev.substy.ai/reference/v1/account-and-agency/get_my_employee_record.md): Read the signed-in account's employee record without supplying an identifier. - [Get my agency membership status](https://docs-dev.substy.ai/reference/v1/account-and-agency/get_my_agency_membership_status.md): Check whether the signed-in account's agency membership has been provisioned in Substy. - [Set my employee timezone](https://docs-dev.substy.ai/reference/v1/account-and-agency/set_my_employee_timezone.md): Update the signed-in employee's timezone used by reporting and time-tracking views. - [Get account profile](https://docs-dev.substy.ai/reference/v1/account-and-agency/get_account_profile.md): Read the authenticated user’s profile, primary email ID, email verification statuses, linked sign-in providers and enabled security settings. Use returned email and external-account IDs when requesting sensitive account changes. - [Update account profile](https://docs-dev.substy.ai/reference/v1/account-and-agency/update_account_profile.md): Replace the authenticated user’s firstName and lastName, then return the updated profile. Supply both fields; at least one must be nonempty. Email, password and linked-provider changes use request_account_action. - [List account sessions](https://docs-dev.substy.ai/reference/v1/account-and-agency/list_account_sessions.md): List the authenticated user’s sign-in sessions with status, last activity, browser, device and location. Supports offset and limit, up to 100 sessions per call; returns totalCount. To revoke a session, pass its ID to request_account_action with kind revoke_session. - [Remove account profile image](https://docs-dev.substy.ai/reference/v1/account-and-agency/remove_account_profile_image.md): Remove the authenticated user’s profile image and return the updated account profile. - [Set account profile image](https://docs-dev.substy.ai/reference/v1/account-and-agency/set_account_profile_image.md): Replace the authenticated user’s profile image with base64 PNG or JPEG file bytes and the matching contentType. Maximum decoded file size is 10 MiB. Returns the updated account profile. - [Request account action](https://docs-dev.substy.ai/reference/v1/account-and-agency/request_account_action.md): Request a sensitive account change: manage emails, change password, connect or unlink a sign-in provider, revoke a session, or delete the account. Supply the action kind and its matching payload. Returns an actionId and a verification URL for the user; check get_account_action_status afterwards. Passwords and verification codes belong only in the verification page. - [Get account action status](https://docs-dev.substy.ai/reference/v1/account-and-agency/get_account_action_status.md): Check an actionId returned by request_account_action after the user completes verification. Returns its status, expiry and recorded outcome. PENDING or RUNNING does not confirm the requested account change; an expired action requires a new request. - [Get agency profile](https://docs-dev.substy.ai/reference/v1/account-and-agency/get_agency_profile.md): Read the selected agency’s ID, name, slug and imageUrl. Use its exact name as confirmation when requesting agency deletion. - [Rename agency](https://docs-dev.substy.ai/reference/v1/account-and-agency/rename_agency.md): Replace the selected agency’s name and return its updated profile. Requires current permission to edit agency settings; this does not select or rename another agency. - [Create agency](https://docs-dev.substy.ai/reference/v1/account-and-agency/create_agency.md): Create an agency owned by the authenticated user using the supplied name. Returns its ID and profile, subject to account agency-creation limits. The selected agency supplies the current permission context; approve a separate connection to the newly created agency before managing it. - [Remove agency logo](https://docs-dev.substy.ai/reference/v1/account-and-agency/remove_agency_logo.md): Remove the selected agency’s logo and return its updated profile. Requires current permission to edit agency settings. - [Set agency logo](https://docs-dev.substy.ai/reference/v1/account-and-agency/set_agency_logo.md): Replace the selected agency’s logo with base64 PNG or JPEG file bytes and the matching contentType. Maximum decoded file size is 10 MiB. Requires agency-settings edit permission and returns the updated agency profile. - [Delete agency](https://docs-dev.substy.ai/reference/v1/account-and-agency/delete_agency.md): Permanently delete the selected agency and revoke its agent connections. Requires agency-deletion permission and confirmationName matching its exact current name from get_agency_profile. Returns the deleted agency ID and deleted status. - [List the agencies allowed by this API key](https://docs-dev.substy.ai/reference/v1/account-and-agency/list_agencies.md): - [List agency creators](https://docs-dev.substy.ai/reference/v1/creator-connections/list_agency_creators.md): List creators belonging to the current agency, optionally filtering pending accounts. Results respect current creator access. - [Connect creator account](https://docs-dev.substy.ai/reference/v1/creator-connections/connect_creator_account.md): Connect a creator account using the supported platform credentials. The result reports connection progress and any required verification step; it never returns stored connection secrets. An OnlyFans account that needs a second factor returns creatorId with twoFaState: continue with send_creator_connection_code, verify_creator_connection_code or start_creator_face_verification. A MYM or Fansly account that asks for a login code returns mfaChallenge and no creatorId: ask the account owner for the code sent to mfaChallenge.destination (by email on Fansly) and submit it with verify_creator_login_code before it expires (about 3 minutes on MYM, 15 on Fansly). - [Verify creator login code](https://docs-dev.substy.ai/reference/v1/creator-connections/verify_creator_login_code.md): Submit the 2FA code the account owner received for a login that returned mfaChallenge (MYM, Fansly), with its pendingConnectId. status=connected returns the connected or reconnected creatorId. status=refused with reason code_invalid allows another attempt; code_expired, account_locked, too_many_attempts and login_failed require a new connect_creator_account login. Only the user who started the login can complete it. - [Resend creator login code](https://docs-dev.substy.ai/reference/v1/creator-connections/resend_creator_login_code.md): Send a new 2FA code for a login that returned mfaChallenge (MYM, Fansly), once its resend wait is over. status=pending returns the refreshed mfaChallenge; status=refused with reason resend_cooldown reports retryAfterSeconds. Only the user who started the login can resend. - [Connect fanvue account](https://docs-dev.substy.ai/reference/v1/creator-connections/connect_fanvue_account.md): Start Fanvue OAuth and return the authorization page for the account owner to open. Authorization must finish before the creator account is connected. - [Import creator accounts](https://docs-dev.substy.ai/reference/v1/creator-connections/import_creator_accounts.md): Connect up to 100 creator accounts from supplied platform credentials. Inspect each account's result for success or a required verification step; split larger imports into separate requests. - [Verify creator connection code](https://docs-dev.substy.ai/reference/v1/creator-connections/verify_creator_connection_code.md): Submit the provider verification code for a pending creator connection (OnlyFans, by creatorId; MYM login codes use verify_creator_login_code). Inspect the returned authentication state before treating the account as connected. - [Send creator connection code](https://docs-dev.substy.ai/reference/v1/creator-connections/send_creator_connection_code.md): Ask the platform to send an SMS verification code for a pending creator connection. This requests a code; use verify_creator_connection_code after the account owner receives it. - [Start creator face verification](https://docs-dev.substy.ai/reference/v1/creator-connections/start_creator_face_verification.md): Start the platform's face-verification step for a pending creator connection. Return the required verification action to the account owner. - [Get creator face verification status](https://docs-dev.substy.ai/reference/v1/creator-connections/get_creator_face_verification_status.md): Read the progress of an already-started creator face verification. A pending result means the account owner still needs to complete the provider's verification. - [Get fanvue connection status](https://docs-dev.substy.ai/reference/v1/creator-connections/get_fanvue_connection_status.md): Check a Fanvue connection using the continuationId returned when connecting the account. Returns its status, expiry and creatorId when complete. Use after the user authorizes Fanvue; expired authorization requires a new connection attempt. - [Get agency wallet](https://docs-dev.substy.ai/reference/v1/billing/get_agency_wallet.md): Read the agency wallet balance, currency and wallet settings. - [Get agency wallet funding status](https://docs-dev.substy.ai/reference/v1/billing/get_agency_wallet_funding_status.md): Check whether the agency wallet has the funds required by the platform's wallet-funding check. - [List wallet transactions](https://docs-dev.substy.ai/reference/v1/billing/list_wallet_transactions.md): List agency wallet transactions using the supplied date, type and pagination filters. - [Export wallet transactions](https://docs-dev.substy.ai/reference/v1/billing/export_wallet_transactions.md): Export matching agency wallet transactions as CSV. Supply the desired date range and transaction filters. - [Update agency wallet settings](https://docs-dev.substy.ai/reference/v1/billing/update_agency_wallet_settings.md): Update the agency wallet's minimum balance and low-balance notification preference. - [Create wallet top up](https://docs-dev.substy.ai/reference/v1/billing/create_wallet_top_up.md): Create a wallet top-up for the supplied amount, payment method and currency. Open the returned checkout when required; a checkout being created does not confirm payment. - [Get agency wallet usage](https://docs-dev.substy.ai/reference/v1/billing/get_agency_wallet_usage.md): Read agency wallet usage over the requested dates and reporting granularity, using the current employee's reporting timezone. - [List wallet payment currencies](https://docs-dev.substy.ai/reference/v1/billing/list_wallet_payment_currencies.md): List the cryptocurrencies supported for agency wallet top-ups. - [Get agency wallet overview](https://docs-dev.substy.ai/reference/v1/billing/get_agency_wallet_overview.md): Read the agency record together with its wallet information for a combined billing overview. - [Get agency billing details](https://docs-dev.substy.ai/reference/v1/billing/get_agency_billing_details.md): Read the agency's saved billing identity and address details. - [Update agency billing details](https://docs-dev.substy.ai/reference/v1/billing/update_agency_billing_details.md): Update the agency's billing identity and address details used for billing documents. - [Get agency creator payout balances](https://docs-dev.substy.ai/reference/v1/billing/get_agency_creator_payout_balances.md): Read payout balances across agency creators. Inspect per-creator results for balances that could not be retrieved. - [List agency payout requests](https://docs-dev.substy.ai/reference/v1/billing/list_agency_payout_requests.md): List payout requests across agency creators using limit and offset. Inspect each creator's result when some platform requests fail. - [List agency payout transactions](https://docs-dev.substy.ai/reference/v1/billing/list_agency_payout_transactions.md): List creator payout transactions using the supported limit and marker pagination. - [Request creator payouts](https://docs-dev.substy.ai/reference/v1/billing/request_creator_payouts.md): Request payouts for the selected creator balances. This moves funds through the platform's payout process; inspect per-creator results and payout history before assuming completion. - [Get wallet payment status](https://docs-dev.substy.ai/reference/v1/billing/get_wallet_payment_status.md): Check a wallet payment using its transactionId. Returns the current transaction status, amount and update time. Use after checkout to confirm processing; a checkout link alone does not confirm payment. - [List fan messages](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/list_fan_messages.md): Read messages between one creator and fan, with pagination and ordering filters. Follow the returned next or previous cursor to retrieve more of the conversation. - [Get fan profile](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/get_fan_profile.md): Read a fan's profile and relationship with one creator, including available spending and subscription details. Fan identity is scoped to the supplied creator. - [Update fan profile](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/update_fan_profile.md): Update the supplied editable relationship fields for a fan and creator, such as notes or AI controls. Omitted fields retain their current values. - [List fan ai logs](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/list_fan_ai_logs.md): Read the AI activity logs available for one creator-fan conversation. Use these records to investigate AI behavior for that fan. - [Get fan profiles](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/get_fan_profiles.md): Look up fan profiles by IDs for one creator. Concise mode returns identity, subscription and spending details, notes, AI state and actual list memberships; full mode retains every sanitized platform field. - [List scheduled fan messages](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/list_scheduled_fan_messages.md): List queued messages for one creator-fan conversation. Use the returned scheduled-message identifier to cancel a pending send. - [Schedule fan message](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/schedule_fan_message.md): Schedule an individual fan message 1–60 minutes from now using delayMinutes, with supported media and paid content. A queued result does not confirm delivery. Direct conversational replies are unavailable through MCP. - [Cancel scheduled fan message](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/cancel_scheduled_fan_message.md): Cancel a queued individual fan message using its scheduled-message identifier. This does not unsend a message that has already been delivered. - [Unsend fan message](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/unsend_fan_message.md): Remove a previously sent message from a creator-fan conversation when the platform permits it. Platform timing and message-state restrictions still apply. - [Unlike fan message](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/unlike_fan_message.md): Remove the creator's existing like from a message in the specified fan conversation. - [Like fan message](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/like_fan_message.md): Add the creator's like to a message in the specified fan conversation. - [List fan gallery messages](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/list_fan_gallery_messages.md): Read messages containing media in one fan conversation. Continue with the returned cursor to retrieve additional gallery messages. - [Get fan ppv statistics](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/get_fan_ppv_statistics.md): Read paid-message purchase and spending statistics for one fan and creator. Use these totals to assess that fan's PPV history. - [List fan scripts](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/list_fan_scripts.md): Read scripts and their availability or progress for one creator-fan conversation. - [Get fan script](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/get_fan_script.md): Read one script in the context of a specific creator and fan, including the fan-specific state used to decide whether it can be sent. - [Add fan to lists](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/add_fan_to_lists.md): Add one fan to the supplied creator-owned platform lists. Obtain list identifiers from list_creator_fan_lists. - [Remove fan from lists](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/remove_fan_from_lists.md): Remove one fan from the supplied creator-owned platform lists without deleting those lists. - [Hide fan conversation](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/hide_fan_conversation.md): Hide the specified fan conversation on the creator's platform account. - [Mute fan conversation](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/mute_fan_conversation.md): Mute the specified fan conversation on the creator's platform account. - [Block fan](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/block_fan.md): Block a fan on the specified creator account, subject to the platform's moderation behavior. - [Restrict fan](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/restrict_fan.md): Apply the platform's restriction to a fan on the specified creator account. - [Unrestrict fan](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/unrestrict_fan.md): Remove the platform's restriction from a fan on the specified creator account. - [Rename fan](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/rename_fan.md): Change the display name used for a fan in the specified creator account. - [Submit fan message feedback](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/submit_fan_message_feedback.md): Save feedback about an AI-generated fan message using its message identifier and a comment. This records feedback and does not send a message to the fan. - [List creator chat inboxes](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/list_creator_chat_inboxes.md): List the creator's split inboxes. Split-inbox access requires an eligible Pro or Elite plan. - [Get creator chat inbox](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/get_creator_chat_inbox.md): Read one of the creator's split inboxes by inbox ID. - [Configure creator chat inboxes](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/configure_creator_chat_inboxes.md): Enable or disable split inboxes and set their count from 2 to 9 for the creator. This changes the creator-wide inbox configuration. - [Remove fan from inbox](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/remove_fan_from_inbox.md): Remove a fan's current split-inbox assignment for the specified creator. - [Assign fan to inbox](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/assign_fan_to_inbox.md): Assign a creator-fan conversation to the specified split inbox. - [Search creator messages](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/search_creator_messages.md): Search creator message history using the supported sender, date and content filters. Use pagination to retrieve additional matches. - [Create message export](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/create_message_export.md): Queue an export of creator message history using the supplied filters. Export creation is asynchronous; inspect export status before downloading the file. - [List creator fan lists](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/list_creator_fan_lists.md): List platform fan lists belonging to a creator, with their supported pagination and filter options. - [Create creator fan list](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/create_creator_fan_list.md): Create a named platform fan list for the creator. Add fans separately using add_fan_to_lists. - [List creator conversations](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/list_creator_conversations.md): List a creator's fan conversations, optionally filtering AI status, unread conversations, human handoffs or inbox. AI status defaults to all conversations. Continue with the returned opaque cursor when more results are available. - [Pin creator fan list](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/pin_creator_fan_list.md): Pin or unpin the selected platform fan list for the creator using the supplied pinned state. - [List creator chat fans](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/list_creator_chat_fans.md): List fan IDs from a creator's conversations, optionally restricted to a platform list. Continue using the returned next cursor. Inclusion does not mean the fan can receive messages. Use get_creator_platform_users to retrieve profiles. - [Get creator unread count](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/get_creator_unread_count.md): Read the creator's current unread-message or unread-conversation counts returned by the platform. - [Get creator handoff count](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/get_creator_handoff_count.md): Read the count of creator conversations handed off for human attention. - [Set fan ai enabled](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/set_fan_ai_enabled.md): Enable or disable AI handling for one creator-fan conversation. Enabling AI can allow autonomous messages to that fan. - [Update fan personal details](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/update_fan_personal_details.md): Update stored personal details for one creator-fan relationship, such as name, interests, location or financial notes. Supply only fields intended to change. - [Delete creator message queue](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/delete_creator_message_queue.md): Delete the specified queued platform message campaign. Requires both queue-management and mass-message permissions. - [List creator conversation languages](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/list_creator_conversation_languages.md): List the conversation languages available for filtering the creator's fan inbox. - [Get fan media history status](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/get_fan_media_history_status.md): Read the stored chat media labeling state for a creator and fan. Poll while the history scan queued by list_vault_media runs. Reports not_synced, labeling, complete, incomplete, failed, or unsupported; this read does not start a scan. - [Get message export status](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/get_message_export_status.md): Check a message export you requested using its jobId. Returns job status, rowCount, truncated and downloadReady. Wait until downloadReady before requesting a download; queued and active jobs have no completed CSV. - [Get message export download](https://docs-dev.substy.ai/reference/v1/inbox-and-fans/get_message_export_download.md): Get a downloadUrl for a completed message export you requested, identified by jobId. Returns a CSV URL valid for five minutes, expiresAt, rowCount and truncated. Requires current access to every creator included in the export; call get_message_export_status first if completion is uncertain. - [List fan segments](https://docs-dev.substy.ai/reference/v1/automations/list_fan_segments.md): List the creator's audience segments and their configured matching rules. - [Create fan segment](https://docs-dev.substy.ai/reference/v1/automations/create_fan_segment.md): Create a creator-specific audience segment with a segment type and supported value or duration conditions. - [Update fan segment](https://docs-dev.substy.ai/reference/v1/automations/update_fan_segment.md): Update a creator's saved audience segment, including its name, segment type and matching conditions. - [Delete fan segment](https://docs-dev.substy.ai/reference/v1/automations/delete_fan_segment.md): Delete a saved audience segment from the specified creator. - [List creator messaging automations](https://docs-dev.substy.ai/reference/v1/automations/list_creator_messaging_automations.md): List the messaging automations configured for one creator. - [Create messaging automation](https://docs-dev.substy.ai/reference/v1/automations/create_messaging_automation.md): Create a creator messaging automation with the supplied trigger, audience and message configuration. Set input.enabled to false for a disabled draft; omission enables it. An enabled automation can send messages to real fans when triggered. - [Get messaging automation](https://docs-dev.substy.ai/reference/v1/automations/get_messaging_automation.md): Read one messaging automation's trigger, audience and message settings by ID. - [Update messaging automation](https://docs-dev.substy.ai/reference/v1/automations/update_messaging_automation.md): Update an existing messaging automation's configuration. Changes to an enabled automation affect subsequent triggered sends. - [Delete messaging automation](https://docs-dev.substy.ai/reference/v1/automations/delete_messaging_automation.md): Delete an existing creator messaging automation by ID. - [Duplicate messaging automation](https://docs-dev.substy.ai/reference/v1/automations/duplicate_messaging_automation.md): Create a copy of an existing messaging automation for the same creator. - [Copy messaging automation to creator](https://docs-dev.substy.ai/reference/v1/automations/copy_messaging_automation_to_creator.md): Copy an existing messaging automation to another accessible creator using the supported target settings. - [Set messaging automation enabled](https://docs-dev.substy.ai/reference/v1/automations/set_messaging_automation_enabled.md): Set whether a messaging automation is enabled. Enabling it permits triggered sends to real fans. - [Get messaging automation follow results](https://docs-dev.substy.ai/reference/v1/automations/get_messaging_automation_follow_results.md): Read the results of an automation's "Follow the fan" action (OnlyFans, subscription expired trigger): fans followed back and followed fans who subscribed again within 30 days, over the last 24 hours, 7 days, 30 days and in total, plus the last 30 days of expiries by outcome. - [List creator tracking links](https://docs-dev.substy.ai/reference/v1/campaigns/list_creator_tracking_links.md): List a creator's tracking links with the supported filters. These links attribute incoming subscribers and traffic to a source. - [Create creator tracking link](https://docs-dev.substy.ai/reference/v1/campaigns/create_creator_tracking_link.md): Create a tracking link for a creator so traffic and subscriptions from that source can be attributed. - [Get creator tracking link](https://docs-dev.substy.ai/reference/v1/campaigns/get_creator_tracking_link.md): Read one creator tracking link by its identifier. - [Update creator tracking link](https://docs-dev.substy.ai/reference/v1/campaigns/update_creator_tracking_link.md): Update the editable fields of an existing creator tracking link. - [Delete creator tracking link](https://docs-dev.substy.ai/reference/v1/campaigns/delete_creator_tracking_link.md): Delete a creator tracking link by its identifier. - [Sync creator tracking links](https://docs-dev.substy.ai/reference/v1/campaigns/sync_creator_tracking_links.md): Refresh the creator's locally stored tracking links from the connected platform. - [List mass messages](https://docs-dev.substy.ai/reference/v1/campaigns/list_mass_messages.md): List a creator's bulk message campaigns using the supported status and pagination filters. - [Create mass message](https://docs-dev.substy.ai/reference/v1/campaigns/create_mass_message.md): Create a bulk campaign for the selected audience, with supported media, PPV price and scheduling. This can send to real fans; inspect the campaign state to determine delivery progress. - [Update mass message](https://docs-dev.substy.ai/reference/v1/campaigns/update_mass_message.md): Update the editable content, audience or other supported fields of an existing bulk message campaign. - [Reschedule mass message](https://docs-dev.substy.ai/reference/v1/campaigns/reschedule_mass_message.md): Change when an existing bulk message campaign is scheduled to send. - [Cancel mass message](https://docs-dev.substy.ai/reference/v1/campaigns/cancel_mass_message.md): Cancel a pending bulk message campaign before it sends. - [Unsend mass message](https://docs-dev.substy.ai/reference/v1/campaigns/unsend_mass_message.md): Remove a previously sent bulk message campaign from recipient conversations when the platform permits it. - [List creator trial links](https://docs-dev.substy.ai/reference/v1/campaigns/list_creator_trial_links.md): List the creator's free subscription trial links and their available status information. - [Create creator trial link](https://docs-dev.substy.ai/reference/v1/campaigns/create_creator_trial_link.md): Create a free subscription trial link for a creator using the supplied duration and redemption limits. - [List creator trial link figures](https://docs-dev.substy.ai/reference/v1/campaigns/list_creator_trial_link_figures.md): List a creator's OnlyFans trial links with their lifetime figures from stored data: fans who claimed each link, spenders, revenue, refunds and chargebacks. - [Archive creator trial link](https://docs-dev.substy.ai/reference/v1/campaigns/archive_creator_trial_link.md): Archive an existing creator trial link using its platform identifier. - [Delete creator trial link](https://docs-dev.substy.ai/reference/v1/campaigns/delete_creator_trial_link.md): Delete an existing free subscription trial link from the creator account. - [Create subscription promotion](https://docs-dev.substy.ai/reference/v1/campaigns/create_subscription_promotion.md): Create a creator subscription discount promotion with its discount percentage, audience, duration and signup limits. - [End subscription promotion](https://docs-dev.substy.ai/reference/v1/campaigns/end_subscription_promotion.md): End an existing creator subscription promotion using its promotion ID. - [Delete subscription promotion](https://docs-dev.substy.ai/reference/v1/campaigns/delete_subscription_promotion.md): Delete a creator subscription promotion using its promotion ID. - [Get tracking link statistics](https://docs-dev.substy.ai/reference/v1/analytics/get_tracking_link_statistics.md): Read tracking-link performance for one creator over the requested period and granularity. Optionally select one link with trackingLinkId. - [Get creator tracking link statistics](https://docs-dev.substy.ai/reference/v1/analytics/get_creator_tracking_link_statistics.md): Read aggregate tracking-link performance for the requested creator or agency-wide selection over the supplied period and granularity. - [Get trial link statistics](https://docs-dev.substy.ai/reference/v1/analytics/get_trial_link_statistics.md): Read OnlyFans trial-link performance for one creator per UTC day over the requested period: revenue and new fans who claimed the links. Optionally select one link. - [Get creator performance statistics](https://docs-dev.substy.ai/reference/v1/analytics/get_creator_performance_statistics.md): Read creator performance over a date range with daily, weekly or monthly aggregation. A null creator selects accessible creators; optionally include a creator breakdown. Reporting uses the employee's timezone. - [Get agency creator statistics](https://docs-dev.substy.ai/reference/v1/analytics/get_agency_creator_statistics.md): Read a performance overview for selected accessible creators over a date range. Choose net or gross earnings; reporting uses the current employee's timezone. - [Get creator sales script statistics](https://docs-dev.substy.ai/reference/v1/analytics/get_creator_sales_script_statistics.md): Read creator-wide sales-script totals and a searchable, sorted page of scripts over an optional date range. Daily figures use the employee timezone unless timezone is supplied. Pages default to 20 scripts; use page and pageSize with totalCount. Script statistics require an eligible subscription. - [Get team performance statistics](https://docs-dev.substy.ai/reference/v1/analytics/get_team_performance_statistics.md): Read employee performance across the supplied period, creator filters and reporting options. Results respect the account's analytics visibility. - [Get ai employee statistics](https://docs-dev.substy.ai/reference/v1/analytics/get_ai_employee_statistics.md): Read AI employee performance for the selected creator and reporting period, with supported creator filters. - [Get ai employee revenue history](https://docs-dev.substy.ai/reference/v1/analytics/get_ai_employee_revenue_history.md): Read revenue attributed to AI over the requested dates and creator filters. - [Get team performance comparison](https://docs-dev.substy.ai/reference/v1/analytics/get_team_performance_comparison.md): Read time-series data comparing employee performance using the requested period and filters. - [List agency recent sales](https://docs-dev.substy.ai/reference/v1/analytics/list_agency_recent_sales.md): Read recent sales across accessible agency creators for the agency overview. - [List team schedules](https://docs-dev.substy.ai/reference/v1/team/list_team_schedules.md): List AI or employee work schedules, filtered by creators, employees, dates and status. These are staffing schedules, not scheduled platform posts or messages. - [Create team schedule](https://docs-dev.substy.ai/reference/v1/team/create_team_schedule.md): Create AI or employee work schedules for the selected creators, dates and time slots. Specify the intended timezone and recurrence settings. - [Get team schedule](https://docs-dev.substy.ai/reference/v1/team/get_team_schedule.md): Read one AI or employee work schedule by its schedule ID. - [Update team schedule](https://docs-dev.substy.ai/reference/v1/team/update_team_schedule.md): Update a work schedule's assigned creators or employees, dates, time slots, timezone, recurrence or completion state. - [Delete team schedule](https://docs-dev.substy.ai/reference/v1/team/delete_team_schedule.md): Delete an AI or employee work schedule by ID. - [Complete team schedule](https://docs-dev.substy.ai/reference/v1/team/complete_team_schedule.md): Mark a work schedule completed, optionally specifying its completion timestamp. - [Create team schedules](https://docs-dev.substy.ai/reference/v1/team/create_team_schedules.md): Create multiple AI or employee work schedules in one request. Each schedule supplies its own creators, dates, time slots and timezone. - [Update team schedules](https://docs-dev.substy.ai/reference/v1/team/update_team_schedules.md): Apply the supplied changes to multiple work schedules, identifying each schedule by ID. - [Delete team schedules](https://docs-dev.substy.ai/reference/v1/team/delete_team_schedules.md): Delete the selected work schedules by ID and return the number deleted. - [List employee team schedules](https://docs-dev.substy.ai/reference/v1/team/list_employee_team_schedules.md): List work schedules assigned to one employee within the supported date filters. - [List weekly team schedules](https://docs-dev.substy.ai/reference/v1/team/list_weekly_team_schedules.md): List agency work schedules for the week beginning at the supplied week-start date. - [List active team schedules](https://docs-dev.substy.ai/reference/v1/team/list_active_team_schedules.md): List agency work schedules currently considered active. - [List completed team schedules](https://docs-dev.substy.ai/reference/v1/team/list_completed_team_schedules.md): List completed agency work schedules within the requested date range. - [Get team shift statistics](https://docs-dev.substy.ai/reference/v1/team/get_team_shift_statistics.md): Read performance statistics for one work schedule using its schedule ID. - [Get team live shift activity](https://docs-dev.substy.ai/reference/v1/team/get_team_live_shift_activity.md): Read which employees are on shift and their active, idle or no-show status, filtered by the supported dates and creators. - [List team actor recent messages](https://docs-dev.substy.ai/reference/v1/team/list_team_actor_recent_messages.md): Read the latest three messages attributed to one employee or AI actor in the live-shift view. Conversation-read permissions still apply. - [List team members](https://docs-dev.substy.ai/reference/v1/team/list_team_members.md): List agency employees with the supported member filters and creator assignments. - [Get team member](https://docs-dev.substy.ai/reference/v1/team/get_team_member.md): Read one agency employee's record and supported performance details. - [Update team member](https://docs-dev.substy.ai/reference/v1/team/update_team_member.md): Update an agency employee's commission percentage, hourly wage or emoji preferences. Only supplied fields are changed. - [Assign creators to team member](https://docs-dev.substy.ai/reference/v1/team/assign_creators_to_team_member.md): Grant an agency employee access to the specified creator accounts through creator assignments. - [Remove creators from team member](https://docs-dev.substy.ai/reference/v1/team/remove_creators_from_team_member.md): Remove the specified creator-account assignments from an agency employee. - [Get my team performance statistics](https://docs-dev.substy.ai/reference/v1/team/get_my_team_performance_statistics.md): Read performance statistics for the current agency employee over the supplied period. - [List team invitations](https://docs-dev.substy.ai/reference/v1/team/list_team_invitations.md): List agency membership invitations using the supported status and pagination filters. - [Invite team member](https://docs-dev.substy.ai/reference/v1/team/invite_team_member.md): Send an agency membership invitation to the supplied email address, optionally using a role the current account can grant. - [Revoke team invitation](https://docs-dev.substy.ai/reference/v1/team/revoke_team_invitation.md): Revoke a pending agency membership invitation by invitation ID. - [Set team member role](https://docs-dev.substy.ai/reference/v1/team/set_team_member_role.md): Change an existing agency employee's role to one the current account can grant. - [Rename team member](https://docs-dev.substy.ai/reference/v1/team/rename_team_member.md): Change an agency employee's display name without changing their login identity. - [Remove team member](https://docs-dev.substy.ai/reference/v1/team/remove_team_member.md): Remove an employee's membership from the agency, subject to role and ownership restrictions. - [List team member emojis](https://docs-dev.substy.ai/reference/v1/team/list_team_member_emojis.md): Read the emoji preferences associated with the specified agency employee. - [Get team member revenue history](https://docs-dev.substy.ai/reference/v1/team/get_team_member_revenue_history.md): Read revenue attributed to one employee over the requested dates and reporting filters. - [List team roles](https://docs-dev.substy.ai/reference/v1/team/list_team_roles.md): List agency roles visible to the current account, including permission sets and data-visibility settings. - [Create team role](https://docs-dev.substy.ai/reference/v1/team/create_team_role.md): Create an agency role with permission keys and SELF or ALL data visibility. The role cannot grant access beyond the current account's authority. - [List assignable team roles](https://docs-dev.substy.ai/reference/v1/team/list_assignable_team_roles.md): List only roles the current account can assign to agency members or invitations. Use these role IDs when inviting members or changing roles. - [List team role audit events](https://docs-dev.substy.ai/reference/v1/team/list_team_role_audit_events.md): List agency role and permission audit events with actor, action, permission and date filters. Use the numeric cursor as an offset for later pages. - [Update team role](https://docs-dev.substy.ai/reference/v1/team/update_team_role.md): Replace an editable agency role's name, presentation, permission set and data-visibility settings. Changes affect members assigned to the role. - [Delete team role](https://docs-dev.substy.ai/reference/v1/team/delete_team_role.md): Delete an editable agency role and provide a replacement role for its affected members. - [Set default team role](https://docs-dev.substy.ai/reference/v1/team/set_default_team_role.md): Choose the agency role used as the default for new memberships or invitations according to agency role rules. - [Assign team role](https://docs-dev.substy.ai/reference/v1/team/assign_team_role.md): Assign an agency role to the specified employee. Use list_assignable_team_roles to find roles the current account may grant. - [Get employee timesheet](https://docs-dev.substy.ai/reference/v1/team/get_employee_timesheet.md): Read one employee's timesheet between calendar dates interpreted in that employee's timezone. - [Create employee work session](https://docs-dev.substy.ai/reference/v1/team/create_employee_work_session.md): Add a manual work session for an employee with explicit start and end timestamps and an optional note. - [List creator team schedules](https://docs-dev.substy.ai/reference/v1/scheduling/list_creator_team_schedules.md): List work schedules assigned to one creator within the supported date filters. - [Get creator ai weekly schedule](https://docs-dev.substy.ai/reference/v1/scheduling/get_creator_ai_weekly_schedule.md): Read the AI weekly work schedule linked to a creator, if one is configured. - [Unlink creator ai weekly schedule](https://docs-dev.substy.ai/reference/v1/scheduling/unlink_creator_ai_weekly_schedule.md): Remove a creator's link to an AI weekly work schedule. - [Link creator ai weekly schedule](https://docs-dev.substy.ai/reference/v1/scheduling/link_creator_ai_weekly_schedule.md): Link a creator to the selected AI weekly work schedule so its timetable controls AI scheduling. - [Get creator ai schedule status](https://docs-dev.substy.ai/reference/v1/scheduling/get_creator_ai_schedule_status.md): Check whether the creator's AI schedule is active at the current time. - [Get agency creator status](https://docs-dev.substy.ai/reference/v1/scheduling/get_agency_creator_status.md): Check whether the current agency has connected creator accounts. - [Export team payroll](https://docs-dev.substy.ai/reference/v1/scheduling/export_team_payroll.md): Generate payroll for the selected employee or all agency employees over calendar dates in each employee's timezone. Options include tips, hourly wages and a flat extra payment per employee. - [Update employee work session](https://docs-dev.substy.ai/reference/v1/scheduling/update_employee_work_session.md): Correct the start time, end time or note of an existing employee work session. - [List creator feed posts](https://docs-dev.substy.ai/reference/v1/publishing/list_creator_feed_posts.md): List a creator's feed posts with the supported filters and pagination. - [Create creator feed post](https://docs-dev.substy.ai/reference/v1/publishing/create_creator_feed_post.md): Publish or schedule a creator feed post with supported media, audience, pricing and fundraising settings. This changes content on the creator's platform account. - [List creator stories](https://docs-dev.substy.ai/reference/v1/publishing/list_creator_stories.md): List stories available on a creator's platform account. - [Create creator story](https://docs-dev.substy.ai/reference/v1/publishing/create_creator_story.md): Publish a creator story using the supplied media and supported story elements. - [Delete creator story](https://docs-dev.substy.ai/reference/v1/publishing/delete_creator_story.md): Delete a published story from the creator's platform account. - [Search story mentions](https://docs-dev.substy.ai/reference/v1/publishing/search_story_mentions.md): Find platform accounts the creator can mention in a story using the supported search input. - [Search story stickers](https://docs-dev.substy.ai/reference/v1/publishing/search_story_stickers.md): Search Giphy stickers or GIFs available for composing a creator story, with limit and offset pagination. - [Get creator scheduled item counts](https://docs-dev.substy.ai/reference/v1/publishing/get_creator_scheduled_item_counts.md): Count scheduled platform chats, posts or streams between calendar dates in the specified timezone. These counts describe publication queues, not team shifts. - [List creator scheduled items](https://docs-dev.substy.ai/reference/v1/publishing/list_creator_scheduled_items.md): List a creator's scheduled platform items between calendar dates in the specified timezone. Use this for queued posts, chats and streams rather than team work schedules. - [Update creator feed post](https://docs-dev.substy.ai/reference/v1/publishing/update_creator_feed_post.md): Update an existing creator feed post using the platform's supported text, media and publication settings. - [Delete creator feed post](https://docs-dev.substy.ai/reference/v1/publishing/delete_creator_feed_post.md): Delete a creator feed post from the connected platform. - [Publish creator scheduled item](https://docs-dev.substy.ai/reference/v1/publishing/publish_creator_scheduled_item.md): Publish an existing scheduled creator item immediately instead of waiting for its scheduled time. - [Create creator scheduled stream](https://docs-dev.substy.ai/reference/v1/publishing/create_creator_scheduled_stream.md): Create a scheduled live-stream announcement for a creator with the supplied publication details. - [Update creator scheduled stream](https://docs-dev.substy.ai/reference/v1/publishing/update_creator_scheduled_stream.md): Update an existing scheduled live-stream announcement for a creator. - [Delete creator scheduled stream](https://docs-dev.substy.ai/reference/v1/publishing/delete_creator_scheduled_stream.md): Delete a creator's scheduled live-stream announcement by its identifier. - [Create subscription bundle](https://docs-dev.substy.ai/reference/v1/scripts/create_subscription_bundle.md): Create a discounted creator subscription offer for durationMonths of 6 or 12 and discountPercent from 0 to 50. This bundles subscription months rather than standalone media. - [Delete subscription bundle](https://docs-dev.substy.ai/reference/v1/scripts/delete_subscription_bundle.md): Delete a discounted creator subscription bundle by bundle ID. This does not delete a solo media bundle. - [Get fan script availability](https://docs-dev.substy.ai/reference/v1/scripts/get_fan_script_availability.md): Check script availability for up to 100 specified fans of one creator. Split larger fan sets into separate requests. - [List creator subscriptions](https://docs-dev.substy.ai/reference/v1/scripts/list_creator_subscriptions.md): List a creator's Substy subscriptions, optionally filtering active, overdue or canceled states and recent cancellations. These are agency plan subscriptions, not fan subscriptions. - [Cancel creator subscription](https://docs-dev.substy.ai/reference/v1/scripts/cancel_creator_subscription.md): Cancel the creator's Substy subscription according to the subscription's current billing and cancellation rules. - [Retry creator subscription payment](https://docs-dev.substy.ai/reference/v1/scripts/retry_creator_subscription_payment.md): Retry collection of a failed payment for the creator's Substy subscription. This can charge the payment method. - [Reactivate creator subscription](https://docs-dev.substy.ai/reference/v1/scripts/reactivate_creator_subscription.md): Reactivate a canceled Substy subscription for the creator when its current state permits reactivation. - [Create creator subscription](https://docs-dev.substy.ai/reference/v1/scripts/create_creator_subscription.md): Start a paid Substy subscription for a creator using an available plan ID and billing cycle, with a trial when supported. - [Get sales script preview](https://docs-dev.substy.ai/reference/v1/scripts/get_sales_script_preview.md): Preview a sales script and its message sequence by script ID without sending it. - [List creator sales scripts](https://docs-dev.substy.ai/reference/v1/scripts/list_creator_sales_scripts.md): List the sales scripts configured for one creator, including their ordering and availability settings. - [Create sales script](https://docs-dev.substy.ai/reference/v1/scripts/create_sales_script.md): Create a sales script for a creator with the supplied metadata and settings. Add sequence messages with create_script_message. - [Delete sales script](https://docs-dev.substy.ai/reference/v1/scripts/delete_sales_script.md): Delete a sales script belonging to the specified creator. - [Reorder sales scripts](https://docs-dev.substy.ai/reference/v1/scripts/reorder_sales_scripts.md): Set the display or selection order of the supplied sales scripts using their positions. - [Update sales script](https://docs-dev.substy.ai/reference/v1/scripts/update_sales_script.md): Update an existing creator sales script's metadata and supported settings. - [Duplicate sales script](https://docs-dev.substy.ai/reference/v1/scripts/duplicate_sales_script.md): Create a copy of a sales script for the same creator. - [Copy sales script to creator](https://docs-dev.substy.ai/reference/v1/scripts/copy_sales_script_to_creator.md): Copy a sales script to another accessible creator using the supported copy options. - [Get creator usable script count](https://docs-dev.substy.ai/reference/v1/scripts/get_creator_usable_script_count.md): Count sales scripts currently usable by the creator according to script eligibility rules. - [Get creator scripts performance](https://docs-dev.substy.ai/reference/v1/scripts/get_creator_scripts_performance.md): Read sends, unlocks, conversion rate and first-PPV unlock rate for every sales script of a creator, all time, over the last 7, 30 or 90 days, or between two days, as the scripts list shows them. Script statistics require an eligible subscription. - [Get sales script statistics](https://docs-dev.substy.ai/reference/v1/scripts/get_sales_script_statistics.md): Read aggregate performance statistics across the messages in one sales script. - [Get script message statistics](https://docs-dev.substy.ai/reference/v1/scripts/get_script_message_statistics.md): Read performance statistics for one message template within a sales script. - [List script messages](https://docs-dev.substy.ai/reference/v1/scripts/list_script_messages.md): List the message templates that make up a sales script, including their content, media, prices and sequence positions. - [Reorder script messages](https://docs-dev.substy.ai/reference/v1/scripts/reorder_script_messages.md): Update message-template positions within a sales script to change its sequence order. - [Get script message](https://docs-dev.substy.ai/reference/v1/scripts/get_script_message.md): Read one sales-script message template by ID. - [Delete script message](https://docs-dev.substy.ai/reference/v1/scripts/delete_script_message.md): Delete one message template from a sales script. This edits the script and does not unsend previously delivered messages. - [Create script message](https://docs-dev.substy.ai/reference/v1/scripts/create_script_message.md): Add a message template to a creator's sales script, including supported text, media, PPV pricing and follow-up content. Creating a template does not send it. - [Update script message](https://docs-dev.substy.ai/reference/v1/scripts/update_script_message.md): Update a sales-script message template's content, media, pricing and other supplied settings. This changes the template rather than messages already sent to fans. - [Update script message pacing](https://docs-dev.substy.ai/reference/v1/scripts/update_script_message_pacing.md): Set the minimum and maximum conversation exchanges before this script step, from 0 to 10. These values count exchanges, not elapsed minutes; null removes the corresponding override. - [List agency subscriptions](https://docs-dev.substy.ai/reference/v1/scripts/list_agency_subscriptions.md): List the agency's Substy subscriptions across its creator accounts. - [Get creator platform media](https://docs-dev.substy.ai/reference/v1/media-and-vault/get_creator_platform_media.md): Read one media item directly from the creator's connected platform. Use vault tools for Substy vault metadata and media-download tools for file bytes. - [Get creator vault confirmation fan](https://docs-dev.substy.ai/reference/v1/media-and-vault/get_creator_vault_confirmation_fan.md): Read the fan ID configured for the creator's OnlyFans vault-upload confirmation step. - [Set creator vault confirmation fan](https://docs-dev.substy.ai/reference/v1/media-and-vault/set_creator_vault_confirmation_fan.md): Set the fan ID used for the creator's OnlyFans vault-upload confirmation. Upload completion may send the standard confirmation to this fan. - [Get vault media](https://docs-dev.substy.ai/reference/v1/media-and-vault/get_vault_media.md): Read one creator vault media record, including its stored metadata and AI context. Use read_media_bytes when file contents are needed. - [Update vault media](https://docs-dev.substy.ai/reference/v1/media-and-vault/update_vault_media.md): Update a creator vault media record using the supplied media metadata. - [List vault media](https://docs-dev.substy.ai/reference/v1/media-and-vault/list_vault_media.md): Search and list creator vault media by text, media type, folder or script usage. Pass fanId for chat-specific mediaStatus (paid, free, unpaid, not_sent); on OnlyFans, Fanvue and MYM the first read queues a background scan of the sent-media history, and until it completes media without a stored send are unknown (null), never not_sent; poll get_fan_media_history_status. Filter statuses to ["not_sent"] to exclude previously sent media. Follow nextCursor while hasMore is true, including empty filtered pages. - [Delete vault media](https://docs-dev.substy.ai/reference/v1/media-and-vault/delete_vault_media.md): Delete the selected media items from the creator's vault using their media IDs. - [Get vault media by ids](https://docs-dev.substy.ai/reference/v1/media-and-vault/get_vault_media_by_ids.md): Look up up to 100 vault media records by ID for one creator. Split larger ID sets into separate requests. - [List vault folders](https://docs-dev.substy.ai/reference/v1/media-and-vault/list_vault_folders.md): List the creator's media-vault folders with item counts and pagination. A null nextCursor indicates the last page. - [Create vault folder](https://docs-dev.substy.ai/reference/v1/media-and-vault/create_vault_folder.md): Create a named folder in the creator's media vault. - [Rename vault folder](https://docs-dev.substy.ai/reference/v1/media-and-vault/rename_vault_folder.md): Rename an existing creator vault folder using its folder ID. - [Delete vault folder](https://docs-dev.substy.ai/reference/v1/media-and-vault/delete_vault_folder.md): Delete the specified folder from the creator's media vault. - [Add media to vault folder](https://docs-dev.substy.ai/reference/v1/media-and-vault/add_media_to_vault_folder.md): Add the selected vault media items to a creator's folder. - [Remove media from vault folder](https://docs-dev.substy.ai/reference/v1/media-and-vault/remove_media_from_vault_folder.md): Remove the selected media items from a vault folder. This changes folder membership rather than deleting the media. - [Initialize direct vault upload](https://docs-dev.substy.ai/reference/v1/media-and-vault/initialize_direct_vault_upload.md): Start a provider-URL upload requiring external HTTP PUT requests. Prefer initialize_vault_upload and upload_vault_part for transfers entirely through MCP. With putUrl, PUT the entire file; with putUrls, PUT ordered 5 MiB chunks. Retain key, uploadId and response ETags for complete_direct_vault_upload. - [Complete direct vault upload](https://docs-dev.substy.ai/reference/v1/media-and-vault/complete_direct_vault_upload.md): Complete a provider-URL upload after external PUTs. For single PUT, etag is lowercase MD5(file) up to 5 MiB; for larger files, MD5 of concatenated raw MD5 digests of 5 MiB chunks, then '-' and chunk count. For multipart PUT, provide each response ETag with one-based PartNumber. Preserve key, uploadId and listId. OnlyFans confirmation runs unless skipConfirmation=true. MCP-managed uploads use complete_vault_upload instead. - [Check agency banned words](https://docs-dev.substy.ai/reference/v1/media-and-vault/check_agency_banned_words.md): Check supplied text against the agency's active banned-word rules. This validates content without sending or publishing it. - [Initialize vault upload](https://docs-dev.substy.ai/reference/v1/media-and-vault/initialize_vault_upload.md): Start uploading a file to a creator vault through MCP. Supply file metadata and total size in bytes; returns an uploadHandle, chunkSize, totalParts and expiry. Send chunks with upload_vault_part, then call complete_vault_upload. OnlyFans upload confirmation is enabled unless skipConfirmation is true. - [Upload vault part](https://docs-dev.substy.ai/reference/v1/media-and-vault/upload_vault_part.md): Upload one file chunk using an uploadHandle from initialize_vault_upload. Supply a one-based partNumber, base64 bytes and their lowercase SHA-256 checksum. Each chunk must match chunkSize except the final remainder. Returns receivedParts; replacing a stored part with different bytes is rejected. - [Get vault upload status](https://docs-dev.substy.ai/reference/v1/media-and-vault/get_vault_upload_status.md): Inspect an uploadHandle for its phase, expiry, receivedParts and processing result. Use receivedParts to identify missing chunks before completing the upload. COMPLETED means the provider accepted processing; inspect returned media identifiers for availability. Check UNKNOWN outcomes before repeating completion. - [Cancel vault upload](https://docs-dev.substy.ai/reference/v1/media-and-vault/cancel_vault_upload.md): Cancel an uploadHandle and remove its staged parts. Returns the updated upload status. Uploads already finalizing, completed or in an uncertain state cannot be cancelled with this tool. - [Complete vault upload](https://docs-dev.substy.ai/reference/v1/media-and-vault/complete_vault_upload.md): Finalize an uploadHandle after every expected part has been stored. Returns upload status and provider processing identifiers; processing may continue before media becomes available. OnlyFans performs its configured upload confirmation unless skipConfirmation was set during initialization. Inspect status after an uncertain outcome. - [Read media bytes](https://docs-dev.substy.ai/reference/v1/media-and-vault/read_media_bytes.md): Read a creator vault media file by creatorId and mediaId. Choose full, preview or thumb; offset and maxBytes are byte counts. Returns base64 content, contentType, byteLength and nextOffset. Continue from nextOffset until null to retrieve the whole file; each call reads at most 1 MiB. - [List ai voice presets](https://docs-dev.substy.ai/reference/v1/ai-settings/list_ai_voice_presets.md): List AI writing-style presets available to the agency, including their tone prompts and emoji preferences. These presets control text style, not audio voices. - [Create ai voice preset](https://docs-dev.substy.ai/reference/v1/ai-settings/create_ai_voice_preset.md): Create an agency AI writing-style preset with a name, prompt and emoji preferences. - [Get ai voice preset](https://docs-dev.substy.ai/reference/v1/ai-settings/get_ai_voice_preset.md): Read one AI writing-style preset by ID, including its prompt and emoji preferences. - [Update ai voice preset](https://docs-dev.substy.ai/reference/v1/ai-settings/update_ai_voice_preset.md): Update the supplied fields of an editable AI writing-style preset. - [Delete ai voice preset](https://docs-dev.substy.ai/reference/v1/ai-settings/delete_ai_voice_preset.md): Delete an editable AI writing-style preset by ID. - [Initialize builtin ai voice presets](https://docs-dev.substy.ai/reference/v1/ai-settings/initialize_builtin_ai_voice_presets.md): Ensure the standard built-in AI writing-style presets exist. This initializes shared preset definitions rather than assigning a style to a creator. - [List default ai voice presets](https://docs-dev.substy.ai/reference/v1/ai-settings/list_default_ai_voice_presets.md): Read the predefined default AI writing-style preset definitions. - [Get creator ai settings](https://docs-dev.substy.ai/reference/v1/ai-settings/get_creator_ai_settings.md): Read a creator's AI behavior, profile and messaging configuration. - [Update creator ai settings](https://docs-dev.substy.ai/reference/v1/ai-settings/update_creator_ai_settings.md): Update the supplied AI behavior, profile or messaging settings for a creator. Changes affect subsequent AI operation. - [Set creator ai mode](https://docs-dev.substy.ai/reference/v1/ai-settings/set_creator_ai_mode.md): Set AI messaging mode for explicit creator IDs or all accessible creators except the supplied exclusions. Enabling autonomous handling can send real fan messages within that target. - [Set creator ai voice preset](https://docs-dev.substy.ai/reference/v1/ai-settings/set_creator_ai_voice_preset.md): Assign an available AI writing-style preset to a creator by preset ID. - [List ai voice note voices](https://docs-dev.substy.ai/reference/v1/ai-settings/list_ai_voice_note_voices.md): List the audio voices of the agency's connected ElevenLabs account (its cloned voices and the library voices it added) that AI voice notes can use. - [Get creator ai voice note voice](https://docs-dev.substy.ai/reference/v1/ai-settings/get_creator_ai_voice_note_voice.md): Read which ElevenLabs voice a creator's AI voice notes use, whether voice notes are on, and what still blocks them (agency key, platform). - [Set creator ai voice note voice](https://docs-dev.substy.ai/reference/v1/ai-settings/set_creator_ai_voice_note_voice.md): Choose the ElevenLabs voice of a creator's AI voice notes from the agency's account, or pass null to turn the creator's voice notes off. - [List creator banned words](https://docs-dev.substy.ai/reference/v1/ai-settings/list_creator_banned_words.md): List banned words applicable to the specified creator under its agency's content rules. - [Search agency banned words](https://docs-dev.substy.ai/reference/v1/ai-settings/search_agency_banned_words.md): Search the agency's banned-word rules by text and active state, using offset and limit for pagination. - [Save agency banned word](https://docs-dev.substy.ai/reference/v1/ai-settings/save_agency_banned_word.md): Create or update an agency banned-word rule with its text and active state. - [Save agency banned words](https://docs-dev.substy.ai/reference/v1/ai-settings/save_agency_banned_words.md): Create or update up to 1,000 agency banned-word rules in one request. - [Delete agency banned word](https://docs-dev.substy.ai/reference/v1/ai-settings/delete_agency_banned_word.md): Delete an agency banned-word rule using its ID. - [Get creator activation status](https://docs-dev.substy.ai/reference/v1/ai-settings/get_creator_activation_status.md): Read a creator's activation checklist, subscription requirements and readiness to enable AI messaging. - [Activate creator ai](https://docs-dev.substy.ai/reference/v1/ai-settings/activate_creator_ai.md): Enable AI messaging for a creator after its activation and subscription requirements pass. This can start autonomous conversations with real fans. - [Open creator browser session](https://docs-dev.substy.ai/reference/v1/intelligence/open_creator_browser_session.md): Open an authenticated OnlyFans, MYM or Fansly Browser handoff for the creator. Return the continuation link to the account owner; never expose platform credentials. Browser access requires eligible permissions, subscription and MCP category grants. - [Initialize intelligence attachment upload](https://docs-dev.substy.ai/reference/v1/intelligence/initialize_intelligence_attachment_upload.md): Create upload details for a Substy Intelligence attachment up to 20 MiB. Transfer the file using the returned instructions before attaching its reference to an Intelligence message. - [List intelligence memories](https://docs-dev.substy.ai/reference/v1/intelligence/list_intelligence_memories.md): List saved Substy Intelligence memories in the selected private or agency scope, up to the requested limit. - [Create intelligence memory](https://docs-dev.substy.ai/reference/v1/intelligence/create_intelligence_memory.md): Save a reusable instruction or fact for Substy Intelligence in private or agency scope, optionally linked to a conversation. - [Delete all intelligence memories](https://docs-dev.substy.ai/reference/v1/intelligence/delete_all_intelligence_memories.md): Delete all saved Substy Intelligence memories the account can remove in the selected private or agency scope. - [Share intelligence memory](https://docs-dev.substy.ai/reference/v1/intelligence/share_intelligence_memory.md): Promote a private Substy Intelligence memory into agency scope so it can be used across the agency. - [Update intelligence memory](https://docs-dev.substy.ai/reference/v1/intelligence/update_intelligence_memory.md): Replace the text of a saved Substy Intelligence memory in the selected private or agency scope. - [Delete intelligence memory](https://docs-dev.substy.ai/reference/v1/intelligence/delete_intelligence_memory.md): Delete one saved Substy Intelligence memory from the selected private or agency scope. - [Delete intelligence conversation memories](https://docs-dev.substy.ai/reference/v1/intelligence/delete_intelligence_conversation_memories.md): Delete saved Substy Intelligence memories associated with one conversation in the selected private or agency scope. - [List intelligence conversations](https://docs-dev.substy.ai/reference/v1/intelligence/list_intelligence_conversations.md): List Substy Intelligence conversations with title search, archived-state filtering and cursor pagination. - [Get intelligence conversation](https://docs-dev.substy.ai/reference/v1/intelligence/get_intelligence_conversation.md): Read a Substy Intelligence conversation and its saved history. History can contain data from other categories and requires their corresponding read access. - [Rename intelligence conversation](https://docs-dev.substy.ai/reference/v1/intelligence/rename_intelligence_conversation.md): Change the title of an existing Substy Intelligence conversation. - [Delete intelligence conversation](https://docs-dev.substy.ai/reference/v1/intelligence/delete_intelligence_conversation.md): Delete the specified Substy Intelligence conversation. - [Set intelligence conversation pinned](https://docs-dev.substy.ai/reference/v1/intelligence/set_intelligence_conversation_pinned.md): Set whether a Substy Intelligence conversation is pinned in the account's conversation list. - [Set intelligence conversation archived](https://docs-dev.substy.ai/reference/v1/intelligence/set_intelligence_conversation_archived.md): Archive or restore a Substy Intelligence conversation using the supplied boolean value. - [Share intelligence conversation](https://docs-dev.substy.ai/reference/v1/intelligence/share_intelligence_conversation.md): Enable sharing for a Substy Intelligence conversation and return its share link. The shared conversation can expose the content already present in its history. - [Unshare intelligence conversation](https://docs-dev.substy.ai/reference/v1/intelligence/unshare_intelligence_conversation.md): Disable sharing for a Substy Intelligence conversation and revoke its current share link. - [Search intelligence mentions](https://docs-dev.substy.ai/reference/v1/intelligence/search_intelligence_mentions.md): Find creators, scripts, automations, media, fans or conversations that can be referenced in a Substy Intelligence message. Filter by mention type and return up to 30 matches. - [Get intelligence mention details](https://docs-dev.substy.ai/reference/v1/intelligence/get_intelligence_mention_details.md): Resolve up to 20 previously identified mention references into the contextual details used by Substy Intelligence. - [Send intelligence message](https://docs-dev.substy.ai/reference/v1/intelligence/send_intelligence_message.md): Send a task or question to Substy Intelligence, optionally with mentions and attachments, and collect response events. The agent can propose platform actions for approval; broad category access is required. Ordinary AI processing charges may apply. - [Resume intelligence run](https://docs-dev.substy.ai/reference/v1/intelligence/resume_intelligence_run.md): Approve or reject one pending Substy Intelligence action and collect the resumed run's events. Approving can execute the proposed platform action. - [Stop intelligence run](https://docs-dev.substy.ai/reference/v1/intelligence/stop_intelligence_run.md): Request cancellation of an active Substy Intelligence run by run ID. Stopping a run does not undo platform actions already completed. - [List solo bundles](https://docs-dev.substy.ai/reference/v1/solo-bundles/list_solo_bundles.md): List a creator's standalone media bundles with search, pricing, intensity, giftability and enabled-state filters. Continue using the returned cursor. - [Create solo bundle](https://docs-dev.substy.ai/reference/v1/solo-bundles/create_solo_bundle.md): Create a standalone media bundle with ordered media, intensity tier, caption and fixed or smart pricing. Prices follow the schema's PPV and floor-price rules. - [Get solo bundle](https://docs-dev.substy.ai/reference/v1/solo-bundles/get_solo_bundle.md): Read one standalone media bundle and its ordered preview or paid media. This is a media offer, not a multi-month subscription bundle. - [Update solo bundle](https://docs-dev.substy.ai/reference/v1/solo-bundles/update_solo_bundle.md): Update the supplied media, caption, pricing or availability fields of a standalone media bundle. - [Delete solo bundle](https://docs-dev.substy.ai/reference/v1/solo-bundles/delete_solo_bundle.md): Delete a standalone media bundle from the creator's sales catalog. - [Get creator solo bundle statistics](https://docs-dev.substy.ai/reference/v1/solo-bundles/get_creator_solo_bundle_statistics.md): Read a creator's standalone media bundle sales: offers sent, unlocks, gifts, conversion rate and revenue in USD, totalled, per intensity tier and per bundle, all time, over the last 7, 30 or 90 days, or between two days in the employee's time zone. - [Get solo bundle statistics](https://docs-dev.substy.ai/reference/v1/solo-bundles/get_solo_bundle_statistics.md): Read one standalone media bundle's offers sent, unlocks, gifts, conversion rate and revenue in USD, all time, over the last 7, 30 or 90 days, or between two days in the employee's time zone. - [Set solo bundle enabled](https://docs-dev.substy.ai/reference/v1/solo-bundles/set_solo_bundle_enabled.md): Enable or disable a standalone media bundle for use in the creator's sales flow. - [Reorder solo bundles](https://docs-dev.substy.ai/reference/v1/solo-bundles/reorder_solo_bundles.md): Set the order of a creator's standalone media bundles using the supplied bundle IDs.