OnlyMonster

https://docs.onlymonster.ai
Admin
OnlyMonster is a comprehensive content creator management platform that streamlines account...
Tokens:84,012
Snippets:941
Trust Score:9.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Query Documentation via HTTP GET

Source: https://docs.onlymonster.ai/changelog

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve dynamic answers.

```http
GET https://docs.onlymonster.ai/changelog.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /ai-magic-assistant/boost-your-content-strategy-with-ai-magic-box.md

Source: https://docs.onlymonster.ai/ai-magic-assistant/boost-your-content-strategy-with-ai-magic-box.md

Perform an HTTP GET request to query the documentation dynamically for specific information or context.

```APIDOC
## GET /ai-magic-assistant/boost-your-content-strategy-with-ai-magic-box.md

### Description
Queries the documentation dynamically to receive a direct answer along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://docs.onlymonster.ai/ai-magic-assistant/boost-your-content-strategy-with-ai-magic-box.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /mimic-ai/persona-setup.md

Source: https://docs.onlymonster.ai/mimic-ai/persona-setup.md

Perform a query against the documentation page to receive an answer based on the content.

```APIDOC
## GET /mimic-ai/persona-setup.md

### Description
Queries the documentation page dynamically to retrieve an answer to a specific question, optionally tailored to a broader goal.

### Method
GET

### Endpoint
https://docs.onlymonster.ai/mimic-ai/persona-setup.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.onlymonster.ai/chatter-features/inboxes-advanced-group-chat-splitting

Perform a GET request to the documentation index to retrieve answers based on a specific question and optional end goal.

```http
GET https://docs.onlymonster.ai/members-features/inboxes-advanced-group-chat-splitting.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### GET /integrations-and-api/webhook-integration.md

Source: https://docs.onlymonster.ai/integrations-and-api/webhook-integration.md

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /integrations-and-api/webhook-integration.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.onlymonster.ai/integrations-and-api/webhook-integration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.onlymonster.ai/ai-magic-assistant/ai-settings-button-configurations-guide.md

Perform an HTTP GET request to the documentation URL to retrieve answers to specific questions or goals.

```http
GET https://docs.onlymonster.ai/ai-magic-assistant/ai-settings-button-configurations-guide.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /members-features/quick-reply.md

Source: https://docs.onlymonster.ai/members-features/quick-reply.md

Perform an HTTP GET request to query the documentation dynamically using natural language questions.

```APIDOC
## GET /members-features/quick-reply.md

### Description
Query the documentation dynamically by asking a question. This is useful when the information is not explicitly present in the current page or you need additional context.

### Method
GET

### Endpoint
https://docs.onlymonster.ai/members-features/quick-reply.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /onlymonster-browser/onlymonster-browser-setup-guide.md

Source: https://docs.onlymonster.ai/onlymonster-browser/onlymonster-browser-setup-guide.md

Queries the documentation page for specific information by providing a question and an optional goal.

```APIDOC
## GET /onlymonster-browser/onlymonster-browser-setup-guide.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.onlymonster.ai/onlymonster-browser/onlymonster-browser-setup-guide.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /team-and-security-management/custom-proxy-setup-for-account-connection.md

Source: https://docs.onlymonster.ai/team-and-security-management/custom-proxy-setup-for-account-connection.md

Performs a natural language query against the documentation page to retrieve information or clarification.

```APIDOC
## GET /team-and-security-management/custom-proxy-setup-for-account-connection.md

### Description
Queries the documentation page to retrieve answers to specific questions, optionally providing a goal to tailor the response.

### Method
GET

### Endpoint
https://docs.onlymonster.ai/team-and-security-management/custom-proxy-setup-for-account-connection.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /team-and-security-management/message-guard/context-detection-beta.md

Source: https://docs.onlymonster.ai/team-and-security-management/message-guard/context-detection-beta.md

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /team-and-security-management/message-guard/context-detection-beta.md

### Description
Queries the documentation dynamically to retrieve information, clarifications, or related sections based on a natural language question.

### Method
GET

### Endpoint
https://docs.onlymonster.ai/team-and-security-management/message-guard/context-detection-beta.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### GET /troubleshooting/advanced-onlymonster-settings-for-troubleshooting.md

Source: https://docs.onlymonster.ai/troubleshooting/advanced-onlymonster-settings-for-troubleshooting.md

Perform a query against the documentation to retrieve answers or context regarding OnlyMonster settings.

```APIDOC
## GET /troubleshooting/advanced-onlymonster-settings-for-troubleshooting.md

### Description
Queries the documentation dynamically to retrieve information or clarification regarding OnlyMonster settings.

### Method
GET

### Endpoint
https://docs.onlymonster.ai/troubleshooting/advanced-onlymonster-settings-for-troubleshooting.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /mimic-ai/autofill-persona.md

Source: https://docs.onlymonster.ai/mimic-ai/autofill-persona.md

Query the documentation dynamically by asking a question related to the Autofill Persona feature.

```APIDOC
## GET /mimic-ai/autofill-persona.md

### Description
Perform an HTTP GET request on the documentation page URL to ask a specific question and retrieve relevant information or excerpts.

### Method
GET

### Endpoint
https://docs.onlymonster.ai/mimic-ai/autofill-persona.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal you are trying to accomplish to help tailor the answer.

### Request Example
GET https://docs.onlymonster.ai/mimic-ai/autofill-persona.md?ask=How long does autofill take?&goal=Setting up a new persona
```

--------------------------------

### GET /mimic-ai/mimic-overview.md

Source: https://docs.onlymonster.ai/mimic-ai/mimic-overview.md

Performs a natural language query against the documentation to retrieve answers and relevant context.

```APIDOC
## GET /mimic-ai/mimic-overview.md

### Description
Queries the documentation dynamically by asking a specific question. The response includes a direct answer and relevant excerpts from the documentation.

### Method
GET

### Endpoint
https://docs.onlymonster.ai/mimic-ai/mimic-overview.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.

### Request Example
GET https://docs.onlymonster.ai/mimic-ai/mimic-overview.md?ask=How are credits calculated?&goal=Understand billing
```

--------------------------------

### POST /api/v0/accounts/{account_id}/vault/medias/uploads/start

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Starts a new vault media upload process. Rate limit: 3 requests per second.

```APIDOC
## POST /api/v0/accounts/{account_id}/vault/medias/uploads/start

### Description
Starts a new vault media upload. Rate limit: 3 requests per second.

### Method
POST

### Endpoint
/api/v0/accounts/{account_id}/vault/medias/uploads/start

### Parameters
#### Path Parameters
- **account_id** (string) - Required - Big integer id as string

#### Request Body
- **name** (string) - Required - Name of the media (1-255 characters)
- **size** (integer) - Required - Size in bytes (1-5368709120)
- **content_type** (string) - Required - MIME type (e.g., image/jpeg)
- **duration** (number) - Optional - Duration of the media

### Response
#### Success Response (200)
- **get_url** (string) - URL to retrieve the media
- **put_url** (string) - URL to upload the media
- **key** (string) - Unique key for the media
- **upload_id** (string) - Optional - ID for multipart uploads
- **parts** (array) - Optional - List of upload parts for multipart uploads
```

--------------------------------

### GET /proxy/v0/platforms/{platform}/accounts/{platform_account_id}/statements/balances

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieves payout balances for a specific platform account.

```APIDOC
## GET /proxy/v0/platforms/{platform}/accounts/{platform_account_id}/statements/balances

### Description
Retrieve payout balances for a platform account. Rate limit: 1 request per second per platform account.

### Method
GET

### Endpoint
/proxy/v0/platforms/{platform}/accounts/{platform_account_id}/statements/balances

### Parameters
#### Path Parameters
- **platform** (string) - Required - Name of the platform. Currently, only "onlyfans" is supported.
- **platform_account_id** (string) - Required - Unique account identifier returned by the OnlyFans platform.

### Response
#### Success Response (200)
- **payoutAvailable** (number) - Balance available for withdrawal.
- **payoutPending** (number) - Earnings not yet matured for withdrawal.
- **currency** (string) - ISO 4217 currency code.
- **minPayoutSumm** (number) - Minimum available balance required to request a payout.
- **maxPayoutSumm** (number) - Maximum amount withdrawable at this moment.
- **withdrawalPeriodOptions** (array) - Withdrawal period options available for the account.
- **manualPayoutPendingDays** (integer) - Number of days a manual payout stays pending.
- **withdrawalPeriod** (string) - Currently selected withdrawal period code.
```

--------------------------------

### OpenAPI Specification for Subscription Retrieval

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Defines the API structure, authentication via x-om-auth-token, and the GET endpoint for retrieving platform account subscriptions.

```json
{"openapi":"3.0.0","info":{"title":"om-api-service","version":"0.36.0"},"tags":[{"name":"statistics","description":"Endpoints for retrieving account statistics."}],"servers":[{"url":"https://omapi.onlymonster.ai","description":"Production"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"x-om-auth-token","description":"API token for authentication"}}},"paths":{"/api/v0/platforms/{platform}/accounts/{platform_account_id}/subscriptions":{"get":{"summary":"Retrieve subscriptions for a platform account","tags":["statistics"],"description":"**Rate limit:** 15 requests per second","parameters":[{"schema":{"format":"date-time","type":"string"},"in":"query","name":"start","required":true,"description":"Start of the subscription timestamp range (ISO 8601 Zulu)."},{"schema":{"format":"date-time","type":"string"},"in":"query","name":"end","required":true,"description":"End of the subscription timestamp range (ISO 8601 Zulu)."},{"schema":{"minimum":10,"maximum":1000,"default":100,"type":"integer"},"in":"query","name":"limit","required":false,"description":"Items per page (min: 10, max: 1000, default: 100)."},{"schema":{"type":"string"},"in":"query","name":"cursor","required":false,"description":"Pagination cursor returned from the previous request."},{"schema":{"type":"string","enum":["onlyfans"]},"in":"path","name":"platform","required":true,"description":"Name of the platform. Currently, only \"onlyfans\" is supported."},{"schema":{"anyOf":[{"pattern":"^(0|[1-9]\\d*)$","maxLength":19,"description":"Big integer id as string","type":"string"},{"type":"string"}]},"in":"path","name":"platform_account_id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"items":{"description":"Array of subscription records associated with the account.","type":"array","items":{"additionalProperties":false,"type":"object","properties":{"fan":{"additionalProperties":false,"type":"object","properties":{"id":{"pattern":"^(0|[1-9]\\d*)$","maxLength":19,"description":"Unique identifier of the fan.","type":"string"}},"required":["id"]},"price_gross":{"description":"Gross subscription price paid by the fan.","type":"number"},"regular_price_gross":{"description":"Regular gross subscription price without discounts.","type":"number"},"action":{"description":"Subscription action type (subscribe, prolong, return, unknown).","type":"string"},"type":{"description":"Subscription type (regular, promo, trial, bundle, auto, discount, personal_trial, unknown).","type":"string"},"subscribed_at":{"format":"date-time","description":"ISO 8601 timestamp of when the subscription started.","type":"string"},"expires_at":{"format":"date-time","description":"ISO 8601 timestamp of when the subscription expires.","type":"string"}},"required":["fan","price_gross","regular_price_gross","action","type","subscribed_at","expires_at"]}},"cursor":{"description":"Base64-encoded cursor for paginating subsequent results. Present only if additional pages exist.","type":"string"}},"required":["items"]}}}}}}}}
```

--------------------------------

### GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/tracking-links

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieves a list of tracking links for a specified platform account within a defined time range.

```APIDOC
## GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/tracking-links

### Description
Retrieves tracking links for a platform account. Rate limit: 15 requests per second.

### Method
GET

### Endpoint
/api/v0/platforms/{platform}/accounts/{platform_account_id}/tracking-links

### Parameters
#### Path Parameters
- **platform** (string) - Required - Name of the platform. Currently, only "onlyfans" is supported.
- **platform_account_id** (string) - Required - Unique account identifier returned by the OnlyFans platform.

#### Query Parameters
- **start** (string) - Required - Start of the tracking link creation timestamp range (ISO 8601 Zulu).
- **end** (string) - Required - End of the tracking link creation timestamp range (ISO 8601 Zulu).
- **limit** (integer) - Optional - Items per page (min:10 max:1000 default:100).
- **cursor** (string) - Optional - Pagination cursor returned from the previous request.

### Response
#### Success Response (200)
- **items** (array) - Array of tracking link records associated with the account.
- **cursor** (string) - Base64-encoded cursor used for paginating subsequent results. Present only if additional pages exist.
```

--------------------------------

### GET /proxy/v0/platforms/{platform}/accounts/{platform_account_id}/statements/payout-requests

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieves a list of payout requests for a specific platform account. Supports pagination via limit, offset, and marker parameters.

```APIDOC
## GET /proxy/v0/platforms/{platform}/accounts/{platform_account_id}/statements/payout-requests

### Description
Retrieves payout requests for a platform account. Rate limit: 1 request per second per platform account.

### Method
GET

### Endpoint
/proxy/v0/platforms/{platform}/accounts/{platform_account_id}/statements/payout-requests

### Parameters
#### Path Parameters
- **platform** (string) - Required - Name of the platform. Currently, only "onlyfans" is supported.
- **platform_account_id** (string) - Required - Unique account identifier returned by the OnlyFans platform.

#### Query Parameters
- **limit** (integer) - Optional - Items per page (min: 1, max: 100, default: 10).
- **offset** (integer) - Optional - Number of items to skip.
- **marker** (number) - Optional - Snapshot marker returned by a previous response for consistent pagination.

### Response
#### Success Response (200)
- **list** (array) - Payout request records, newest first.
- **marker** (number|null) - Snapshot marker for consistent pagination.

#### Error Response (422)
- **message** (string) - Human-readable explanation of the failure.
- **code** (string) - Machine-readable error code (PLATFORM_ACCOUNT_SESSION_UNAVAILABLE).
```

--------------------------------

### GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/trial-links

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieves a list of trial links for a specific platform account within a defined time range. This endpoint is subject to a rate limit of 15 requests per second.

```APIDOC
## GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/trial-links

### Description
Retrieves trial links for a platform account. Rate limit: 15 requests per second.

### Method
GET

### Endpoint
/api/v0/platforms/{platform}/accounts/{platform_account_id}/trial-links

### Parameters
#### Path Parameters
- **platform** (string) - Required - Name of the platform. Currently, only "onlyfans" is supported.
- **platform_account_id** (string) - Required - Unique account identifier returned by the OnlyFans platform.

#### Query Parameters
- **start** (string) - Required - Start of the trial link creation timestamp range (ISO 8601 Zulu).
- **end** (string) - Required - End of the trial link creation timestamp range (ISO 8601 Zulu).
- **limit** (integer) - Optional - Items per page (min:10 max:1000 default:100).
- **cursor** (string) - Optional - Pagination cursor returned from the previous request.

### Response
#### Success Response (200)
- **items** (array) - Array of trial link records associated with the account.
- **cursor** (string) - Base64-encoded cursor used for paginating subsequent results.
```

--------------------------------

### GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/trial-link-users

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieves a list of trial link users for a specified platform account. This endpoint supports filtering by date range and link ID, and includes pagination via cursors.

```APIDOC
## GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/trial-link-users

### Description
Retrieve trial link users for a platform account. Rate limit: 15 requests per second.

### Method
GET

### Endpoint
/api/v0/platforms/{platform}/accounts/{platform_account_id}/trial-link-users

### Parameters
#### Path Parameters
- **platform** (string) - Required - Name of the platform. Currently, only "onlyfans" is supported.
- **platform_account_id** (string) - Required - Unique account identifier returned by the OnlyFans platform.

#### Query Parameters
- **collected_from** (string) - Optional - Start of the collected_at timestamp range filter (ISO 8601 Zulu).
- **collected_to** (string) - Optional - End of the collected_at timestamp range filter (ISO 8601 Zulu).
- **limit** (integer) - Optional - Items per page (min:1 max:750 default:100).
- **cursor** (string) - Optional - Pagination cursor returned from the previous request.
- **link_id** (string) - Optional - Filter results to a specific trial link ID.

### Response
#### Success Response (200)
- **items** (array) - Array of trial link user records associated with the account.
- **cursor** (string) - Base64-encoded cursor for paginating subsequent results. Present only if additional pages exist.
```

--------------------------------

### OpenAPI Specification for Chargebacks Endpoint

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Defines the GET endpoint for retrieving chargebacks, including path parameters for platform and account ID, and query parameters for date ranges and pagination.

```json
{"openapi":"3.0.0","info":{"title":"om-api-service","version":"0.36.0"},"tags":[{"name":"statistics","description":"Endpoints for retrieving account statistics."}],"servers":[{"url":"https://omapi.onlymonster.ai","description":"Production"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"x-om-auth-token","description":"API token for authentication"}}},"paths":{"/api/v0/platforms/{platform}/accounts/{platform_account_id}/chargebacks":{"get":{"summary":"Retrieve chargebacks for a platform account","description":"**Rate limit:** 15 requests per second","tags":["statistics"],"parameters":[{"name":"platform","in":"path","required":true,"schema":{"type":"string","enum":["onlyfans"]},"description":"Name of the platform. Currently, only \"onlyfans\" is supported."},{"name":"platform_account_id","in":"path","required":true,"schema":{"type":"string"},"description":"Unique account identifier returned by the OnlyFans platform."},{"name":"start","in":"query","required":true,"schema":{"type":"string","format":"date-time"},"description":"Start of the chargeback creation timestamp range (ISO 8601 Zulu)."},{"name":"end","in":"query","required":true,"schema":{"type":"string","format":"date-time"},"description":"End of the chargeback creation timestamp range (ISO 8601 Zulu)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":10,"maximum":1000,"default":100},"description":"Items per page (min:10 max:1000 default:100)"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"base64-signed string"},"description":"Pagination cursor returned from the previous request."}],"responses":{"200":{"description":"List of chargebacks successfully retrieved for the specified platform account.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","description":"Array of chargeback records associated with the account.","items":{"type":"object","properties":{"id":{"type":"string","description":"Globally unique identifier of the chargeback transaction."},"amount":{"type":"number","description":"Monetary amount of the chargeback."},"fan":{"type":"object","description":"Information about the fan associated with this chargeback.","properties":{"id":{"type":"string","description":"Unique identifier of the fan."}},"required":["id"]},"type":{"type":"string","description":"Type of the original transaction (e.g., tip, message payment)."},"status":{"type":"string","description":"Current state of the chargeback (e.g., undo)."},"chargeback_timestamp":{"type":"string","format":"date-time","description":"ISO 8601 timestamp indicating when the chargeback was created."},"transaction_timestamp":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of the original transaction."}},"required":["id","amount","fan","type","status","chargeback_timestamp","transaction_timestamp"]}},"cursor":{"type":"string","description":"Base64-encoded cursor used for paginating subsequent results. Present only if additional pages exist."}},"required":["items"]}}}}}}}}
```

--------------------------------

### GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/subscriptions

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieves a list of subscription records for a specific platform account within a defined time range.

```APIDOC
## GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/subscriptions

### Description
Retrieves subscription records for a platform account. This endpoint is rate-limited to 15 requests per second.

### Method
GET

### Endpoint
/api/v0/platforms/{platform}/accounts/{platform_account_id}/subscriptions

### Parameters
#### Path Parameters
- **platform** (string) - Required - Name of the platform. Currently, only "onlyfans" is supported.
- **platform_account_id** (string) - Required - Unique identifier of the platform account.

#### Query Parameters
- **start** (string) - Required - Start of the subscription timestamp range (ISO 8601 Zulu).
- **end** (string) - Required - End of the subscription timestamp range (ISO 8601 Zulu).
- **limit** (integer) - Optional - Items per page (min: 10, max: 1000, default: 100).
- **cursor** (string) - Optional - Pagination cursor returned from the previous request.

### Response
#### Success Response (200)
- **items** (array) - Array of subscription records associated with the account.
- **cursor** (string) - Base64-encoded cursor for paginating subsequent results. Present only if additional pages exist.
```

--------------------------------

### GET /api/v0/accounts/{account_id}/vault/folders/{folder_id}/medias

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieve a list of media items from a specific vault folder. This endpoint is restricted to OnlyFans accounts and has a rate limit of 5 requests per second.

```APIDOC
## GET /api/v0/accounts/{account_id}/vault/folders/{folder_id}/medias

### Description
Retrieve medias from a vault folder. (For OnlyFans account only). Rate limit: 5 requests per second.

### Method
GET

### Endpoint
/api/v0/accounts/{account_id}/vault/folders/{folder_id}/medias

### Parameters
#### Path Parameters
- **account_id** (string) - Required - Big integer id as string
- **folder_id** (string) - Required - Folder identifier

#### Query Parameters
- **limit** (integer) - Optional - Number of items to return (default: 10, range: 1-10)
- **offset** (integer) - Optional - Number of items to skip (default: 0)
- **type** (string) - Optional - Media type filter (audio, video, photo, gif, all; default: all)

### Response
#### Success Response (200)
- **items** (array) - List of media objects
  - **id** (integer) - Media ID
  - **type** (string) - Media type
  - **can_view** (boolean) - Whether the media can be viewed
  - **is_ready** (boolean) - Whether the media is ready
  - **has_error** (boolean|null) - Error status
  - **converted_to_video** (boolean) - Conversion status
  - **created_at** (string|null) - Creation timestamp
  - **thumbnail_url** (string) - URL to the thumbnail
```

--------------------------------

### GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/chargebacks

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieves a list of chargebacks for a specific platform account within a defined time range. This endpoint is rate-limited to 15 requests per second.

```APIDOC
## GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/chargebacks

### Description
Retrieves a list of chargebacks for a specific platform account within a defined time range. This endpoint is rate-limited to 15 requests per second.

### Method
GET

### Endpoint
/api/v0/platforms/{platform}/accounts/{platform_account_id}/chargebacks

### Parameters
#### Path Parameters
- **platform** (string) - Required - Name of the platform. Currently, only "onlyfans" is supported.
- **platform_account_id** (string) - Required - Unique account identifier returned by the OnlyFans platform.

#### Query Parameters
- **start** (string, date-time) - Required - Start of the chargeback creation timestamp range (ISO 8601 Zulu).
- **end** (string, date-time) - Required - End of the chargeback creation timestamp range (ISO 8601 Zulu).
- **limit** (integer) - Optional - Items per page (min:10 max:1000 default:100).
- **cursor** (string) - Optional - Pagination cursor returned from the previous request.

### Response
#### Success Response (200)
- **items** (array) - Array of chargeback records associated with the account.
- **cursor** (string) - Base64-encoded cursor used for paginating subsequent results. Present only if additional pages exist.
```

--------------------------------

### GET /api/v0/accounts/{account_id}/vault/media/{media_id}/thumbnail

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Streams a media thumbnail from the vault for an OnlyFans account. This endpoint is subject to a rate limit of 3 requests per second.

```APIDOC
## GET /api/v0/accounts/{account_id}/vault/media/{media_id}/thumbnail

### Description
Stream a media thumbnail from the vault. (For OnlyFans account only). Rate limit: 3 requests per second.

### Method
GET

### Endpoint
/api/v0/accounts/{account_id}/vault/media/{media_id}/thumbnail

### Parameters
#### Path Parameters
- **account_id** (string) - Required - Big integer id as string
- **media_id** (integer) - Required

### Response
#### Success Response (200)
- **binary** (application/octet-stream) - Default Response
```

--------------------------------

### GET /api/v0/users/metrics

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieve user metrics for the OnlyFans platform with support for filtering by creator, user, account group, or role, and pagination.

```APIDOC
## GET /api/v0/users/metrics

### Description
Retrieve user metrics for OnlyFans platform. Rate limit: 15 requests per second.

### Method
GET

### Endpoint
/api/v0/users/metrics

### Parameters
#### Query Parameters
- **from** (string, date-time) - Required - Start of the metrics timestamp range (ISO 8601 Zulu).
- **to** (string, date-time) - Required - End of the metrics timestamp range (ISO 8601 Zulu).
- **creator_ids** (array) - Optional - Array of creator IDs to filter metrics by.
- **user_ids** (array) - Optional - Array of user IDs to filter metrics by.
- **account_group_id** (integer) - Optional - Account group ID to filter metrics by.
- **role_id** (integer) - Optional - Role ID to filter metrics by.
- **offset** (integer) - Required - Offset for pagination (default: 0).
- **limit** (integer) - Required - Limit for pagination (max 100, default: 100).

### Response
#### Success Response (200)
- **items** (array) - List of user metric objects containing fields such as user_id, fans_count, messages_count, and various financial/activity metrics.
```

--------------------------------

### GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/tracking-link-users

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieves a list of tracking link users for a specific platform account. This endpoint is rate-limited to 15 requests per second.

```APIDOC
## GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/tracking-link-users

### Description
Retrieves tracking link users for a platform account. Rate limit: 15 requests per second.

### Method
GET

### Endpoint
/api/v0/platforms/{platform}/accounts/{platform_account_id}/tracking-link-users

### Parameters
#### Path Parameters
- **platform** (string) - Required - Name of the platform. Currently, only "onlyfans" is supported.
- **platform_account_id** (string) - Required - Unique account identifier returned by the OnlyFans platform.

#### Query Parameters
- **collected_from** (string) - Optional - Start of the collection timestamp range (ISO 8601 Zulu).
- **collected_to** (string) - Optional - End of the collection timestamp range (ISO 8601 Zulu).
- **limit** (integer) - Optional - Items per page (min:1 max:750 default:100).
- **cursor** (string) - Optional - Pagination cursor returned from the previous request.
- **link_id** (string) - Optional - Filter results by a specific tracking link ID.

### Response
#### Success Response (200)
- **items** (array) - Array of tracking link user records associated with the account.
- **cursor** (string) - Base64-encoded cursor used for paginating subsequent results.
```

--------------------------------

### GET /api/v0/accounts/{account_id}/vault/medias/uploads

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Lists media uploads for a specific vault account. This endpoint is subject to a rate limit of 3 requests per second.

```APIDOC
## GET /api/v0/accounts/{account_id}/vault/medias/uploads

### Description
List media uploads for a vault account. Rate limit: 3 requests per second.

### Method
GET

### Endpoint
/api/v0/accounts/{account_id}/vault/medias/uploads

### Parameters
#### Path Parameters
- **account_id** (string) - Required - Big integer id as string

#### Query Parameters
- **limit** (integer) - Optional - Default: 10
- **offset** (integer) - Optional - Default: 0
- **expired** (boolean) - Optional

### Response
#### Success Response (200)
- **items** (array) - List of media uploads
- **total** (integer) - Total count of items
```

--------------------------------

### GET /api/v0/accounts/{account_id}/vault/folders

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieve a list of vault folders for a specific platform account. This endpoint is restricted to OnlyFans accounts and is subject to a rate limit of 5 requests per second.

```APIDOC
## GET /api/v0/accounts/{account_id}/vault/folders

### Description
Retrieve vault folders for a platform account. (For OnlyFans account only). Rate limit: 5 requests per second.

### Method
GET

### Endpoint
/api/v0/accounts/{account_id}/vault/folders

### Parameters
#### Path Parameters
- **account_id** (string) - Required - Big integer id as string

#### Query Parameters
- **limit** (integer) - Optional - Default: 10, Min: 1, Max: 10
- **offset** (integer) - Optional - Default: 0, Min: 0

### Response
#### Success Response (200)
- **items** (array) - List of vault folders
  - **id** (number) - Folder ID
  - **type** (string) - Folder type
  - **name** (string) - Folder name
  - **has_media** (boolean) - Indicates if folder contains media
  - **can_update** (boolean) - Permission to update
  - **can_delete** (boolean) - Permission to delete
  - **videos_count** (number) - Count of videos
  - **photos_count** (number) - Count of photos
  - **gifs_count** (number) - Count of gifs
  - **audios_count** (number) - Count of audios
```

--------------------------------

### Start upload process

Source: https://docs.onlymonster.ai/integrations-and-api/vault-media-upload-via-onlymonster-api.md

Initiates the upload by reserving an S3 object key and receiving presigned URLs.

```bash
curl -X POST ".../uploads/start" -d '{ "name": "...", "size": ..., "content_type": "..." }'
```

--------------------------------

### Chat Message Event Example

Source: https://docs.onlymonster.ai/integrations-and-api/webhook-integration?q=api

Example payload for a chat.message event triggered by incoming or outgoing messages.

```json
{
  "type": "chat.message",
  "payload": {
    "account": {
      "account_id": "acc_01HZY...",
      "platform_account_id": "11122233"
    },
    "message": {
      "message_id": "1234567890",
      "fan_id": "987654321",
      "from_id": "987654321",
      "created_at": "2026-04-27T10:00:00.000Z",
      "text": "Hi!",
      "medias": {
        "55501": { "type": "photo" }
      }
    }
  }
}
```

--------------------------------

### POST /uploads/start

Source: https://docs.onlymonster.ai/integrations-and-api/vault-media-upload-via-onlymonster-api.md

Initiates a media upload process by reserving an S3 object key and returning presigned URLs.

```APIDOC
## POST /uploads/start

### Description
Reserves an S3 object key and returns presigned URL(s). The response structure determines whether a single-PUT or multipart upload strategy should be used.

### Method
POST

### Endpoint
/uploads/start

### Request Body
- **name** (string) - Required - The name of the file.
- **size** (number) - Required - The size of the file in bytes.
- **content_type** (string) - Required - The MIME type of the file.
```

--------------------------------

### GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/transactions

Source: https://docs.onlymonster.ai/integrations-and-api/openapi.md

Retrieves a list of transactions for a specific platform account within a defined time range. This endpoint supports pagination via a cursor and is rate-limited to 15 requests per second.

```APIDOC
## GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/transactions

### Description
Retrieves a list of transactions for a platform account. Rate limit is 15 requests per second.

### Method
GET

### Endpoint
/api/v0/platforms/{platform}/accounts/{platform_account_id}/transactions

### Parameters
#### Path Parameters
- **platform** (string) - Required - Name of the platform. Currently, only "onlyfans" is supported.
- **platform_account_id** (string) - Required - Unique account identifier returned by the OnlyFans platform.

#### Query Parameters
- **start** (string) - Required - Start of the transaction creation timestamp range (ISO 8601 Zulu).
- **end** (string) - Required - End of the transaction creation timestamp range (ISO 8601 Zulu).
- **limit** (integer) - Optional - Items per page (min:10 max:1000 default:100).
- **cursor** (string) - Optional - Pagination cursor returned from the previous request.

### Response
#### Success Response (200)
- **items** (array) - Array of transaction records associated with the account.
- **cursor** (string) - Base64-encoded cursor used for paginating subsequent results. Included only if additional pages exist.
```

--------------------------------

### Restored Chat Message Event Example

Source: https://docs.onlymonster.ai/integrations-and-api/webhook-integration?q=api

Example payload for a chat.message event delivered after a connection restoration, including metadata.

```json
{
  "type": "chat.message",
  "payload": {
    "account": { "...": "..." },
    "message": { "...": "..." },
    "metadata": {
      "is_restored": true,
      "connection_lost_at": "2026-04-27T09:55:00.000Z"
    }
  }
}
```

--------------------------------

### Chat Message Sent Event Example

Source: https://docs.onlymonster.ai/integrations-and-api/webhook-integration?q=api

Example payload for a chat.message_sent event, confirming delivery of a message submitted via the API.

```json
{
  "type": "chat.message_sent",
  "payload": {
    "send_id": "snd_01HZX...",
    "account_id": "acc_01HZY...",
    "fan_id": "987654321",
    "platform_message_id": "1234567890"
  }
}
```
Tokens:
Raw