Onlymonster API

Base URLs

• Production: https://omapi.onlymonster.ai

Rate limits

• Token limit: 25 requests per second across all endpoints.

• Endpoint limit: 15 requests per second per endpoint (default). Some endpoints override this — see the description on each endpoint.

• Exceeding either limit returns 429 Rate limit exceeded.

Get list of accounts.

get

Rate limit: 15 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Query parameters

cursorstring · min: 2Optional

limitinteger · min: 1 · max: 1000Optional

withExpiredSubscriptionsbooleanOptional

Responses

200

Default Response

application/json

get

/api/v0/accounts

HTTPcURLJavaScriptPython

GET /api/v0/accounts HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

Default Response

{
  "accounts": [
    {
      "id": 1,
      "platform_account_id": "1",
      "platform": "text",
      "name": "text",
      "email": "text",
      "avatar": "text",
      "username": "text",
      "organisation_id": "1",
      "subscribe_price": 1,
      "subscription_expiration_date": "2026-05-21T08:37:26.158Z"
    }
  ],
  "nextCursor": "text"
}

Get account by ID.

get

Rate limit: 15 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

Responses

200

Default Response

application/json

get

/api/v0/accounts/{account_id}

HTTPcURLJavaScriptPython

GET /api/v0/accounts/{account_id} HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

Default Response

{
  "account": {
    "id": 1,
    "platform_account_id": "1",
    "platform": "text",
    "name": "text",
    "email": "text",
    "avatar": "text",
    "username": "text",
    "organisation_id": "1",
    "subscribe_price": 1,
    "subscription_expiration_date": "2026-05-21T08:37:26.158Z"
  }
}

Get fan IDs for an account based on recent chat activity.

get

Rate limit: 1 request per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

Query parameters

limitinteger · min: 1 · max: 10000OptionalDefault: 10000

Responses

200

Default Response

application/json

get

/api/v0/accounts/{account_id}/fans

HTTPcURLJavaScriptPython

GET /api/v0/accounts/{account_id}/fans HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

Default Response

{
  "fan_ids": [
    "text"
  ]
}

Get chat messages for a specific chat.

get

Rate limit: 1 request per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

chat_idstring · min: 1 · max: 100Required

Query parameters

limitinteger · min: 1 · max: 100OptionalDefault: 100

message_idintegerOptional

ID of the last message from previous page. Used for pagination

orderany ofOptionalExample: {"value":"asc"}

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

Responses

200

Default Response

application/json

get

/api/v0/accounts/{account_id}/chats/{chat_id}/messages

HTTPcURLJavaScriptPython

GET /api/v0/accounts/{account_id}/chats/{chat_id}/messages HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

Default Response

{
  "items": [
    {
      "id": 1,
      "text": "text",
      "from_user": 1,
      "is_sent_by_me": true,
      "created_at": "text",
      "media": [
        {
          "id": 1,
          "type": "text",
          "can_view": true,
          "is_ready": true,
          "has_error": true,
          "converted_to_video": true,
          "created_at": "text",
          "thumbnail_url": "text"
        }
      ],
      "media_count": 1,
      "is_opened": true,
      "is_new": true,
      "price": 1,
      "is_free": true,
      "can_purchase": true,
      "can_purchase_reason": "text"
    }
  ],
  "has_more": true
}

Send a message to a chat.

post

Rate limit: 1 request per second

The message text is scanned by the content-moderation service before being enqueued. Requests whose text matches restricted words or topics return 400 with code: "RESTRICTED_WORDS_DETECTED" and the matching words / topics in details.

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

chat_idstring · min: 1 · max: 100Required

Body

application/json

and

anyOptional

and

anyOptional

and

anyOptional

and

anyOptional

Responses

202

Default Response

application/json

400

Default Response

application/json

post

/api/v0/accounts/{account_id}/chats/{chat_id}/messages

HTTPcURLJavaScriptPython

POST /api/v0/accounts/{account_id}/chats/{chat_id}/messages HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "text": null,
  "price": 0,
  "locked_text": false,
  "media": [
    {
      "id": "text",
      "type": "image",
      "is_paid": true
    }
  ]
}

{
  "send_id": "123e4567-e89b-12d3-a456-426614174000"
}

Retrieve tracking links for a platform account

get

Rate limit: 15 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

platformstring · enumRequired

Name of the platform. Currently, only "onlyfans" is supported.

Example: onlyfansPossible values:

platform_account_idstringRequired

Unique account identifier returned by the OnlyFans platform.

Example: 000000000

Query parameters

startstring · date-timeRequired

Start of the tracking link creation timestamp range (ISO 8601 Zulu).

Example: 2025-10-01T00:00:00.000Z

endstring · date-timeRequired

End of the tracking link creation timestamp range (ISO 8601 Zulu).

Example: 2025-10-31T23:59:59.999Z

limitinteger · min: 10 · max: 1000Optional

Items per page (min:10 max:1000 default:100)

Example: 100

cursorstringOptional

base64-signed string

Responses

200

List of tracking links successfully retrieved for the specified platform account.

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/tracking-links?start=2025-10-01T00%3A00%3A00.000Z&end=2025-10-31T23%3A59%3A59.999Z HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

List of tracking links successfully retrieved for the specified platform account.

{
  "items": [
    {
      "id": "1040071",
      "name": "Tracking Link 1",
      "subscribers": 939,
      "url": "https://onlyfans.com/some-name/c16",
      "is_active": true,
      "clicks": 49166,
      "created_at": "2024-06-16T20:47:37.000Z"
    },
    {
      "id": "940779",
      "name": "Tracking Link 2",
      "subscribers": 1213,
      "url": "https://onlyfans.com/some-name/c15",
      "is_active": true,
      "clicks": 75512,
      "created_at": "2024-05-07T19:20:16.000Z"
    }
  ],
  "cursor": "dHN4"
}

Retrieve tracking link users for a platform account

get

Rate limit: 15 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

platformstring · enumRequired

Name of the platform. Currently, only "onlyfans" is supported.

Example: onlyfansPossible values:

platform_account_idstringRequired

Unique account identifier returned by the OnlyFans platform.

Example: 000000000

Query parameters

collected_fromstring · date-timeOptional

Start of the collection timestamp range (ISO 8601 Zulu).

Example: 2025-10-01T00:00:00.000Z

collected_tostring · date-timeOptional

End of the collection timestamp range (ISO 8601 Zulu).

Example: 2026-10-31T23:59:59.999Z

limitinteger · min: 1 · max: 750Optional

Items per page (min:1 max:750 default:100)

Example: 100

cursorstringOptional

base64-signed string

link_idstringOptional

Filter results by a specific tracking link ID.

Example: 123

Responses

200

List of tracking link users successfully retrieved for the specified platform account.

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/tracking-link-users HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

List of tracking link users successfully retrieved for the specified platform account.

{
  "items": [
    {
      "link_id": "1000001",
      "fan": {
        "id": "123456789",
        "name": "John Doe",
        "username": "johndoe"
      },
      "subscribed_at": "2025-10-15T10:30:00.000Z",
      "collected_at": "2025-10-15T11:00:00.000Z"
    }
  ],
  "cursor": "dHN4"
}

Retrieve trial links for a platform account

get

Rate limit: 15 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

platformstring · enumRequired

Name of the platform. Currently, only "onlyfans" is supported.

Example: onlyfansPossible values:

platform_account_idstringRequired

Unique account identifier returned by the OnlyFans platform.

Example: 000000000

Query parameters

startstring · date-timeRequired

Start of the trial link creation timestamp range (ISO 8601 Zulu).

Example: 2025-10-01T00:00:00.000Z

endstring · date-timeRequired

End of the trial link creation timestamp range (ISO 8601 Zulu).

Example: 2025-10-31T23:59:59.999Z

limitinteger · min: 10 · max: 1000Optional

Items per page (min:10 max:1000 default:100)

Example: 100

cursorstringOptional

base64-signed string

Responses

200

List of trial links successfully retrieved for the specified platform account.

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/trial-links?start=2025-10-01T00%3A00%3A00.000Z&end=2025-10-31T23%3A59%3A59.999Z HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

List of trial links successfully retrieved for the specified platform account.

{
  "items": [
    {
      "id": "10668344",
      "name": "Trial Link 1",
      "claims": 18,
      "claims_limit": 0,
      "url": "https://onlyfans.com/some-name/trial/bwmsqiakh3p1mvgec1gfutz6r26tbmav",
      "duration_days": 3,
      "expires_at": null,
      "is_active": true,
      "clicks": 20,
      "created_at": "2025-10-06T14:16:01.000Z"
    },
    {
      "id": "10611345",
      "name": "Trial Link 2",
      "claims": 0,
      "claims_limit": 0,
      "url": "https://onlyfans.com/some-name/trial/ndzgpob7tptoqargxapzpbgrxv0u8s6f",
      "duration_days": 3,
      "expires_at": null,
      "is_active": true,
      "clicks": 0,
      "created_at": "2025-09-19T21:03:38.000Z"
    }
  ],
  "cursor": "dHN4"
}

Retrieve trial link users for a platform account

get

Rate limit: 15 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

platformstring · enumRequired

Name of the platform. Currently, only "onlyfans" is supported.

Example: onlyfansPossible values:

platform_account_idstringRequired

Unique account identifier returned by the OnlyFans platform.

Example: 000000000

Query parameters

collected_fromstring · date-timeOptional

Start of the collected_at timestamp range filter (ISO 8601 Zulu).

Example: 2025-10-01T00:00:00.000Z

collected_tostring · date-timeOptional

End of the collected_at timestamp range filter (ISO 8601 Zulu).

Example: 2025-10-31T23:59:59.999Z

limitinteger · min: 1 · max: 750Optional

Items per page (min:1 max:750 default:100)

Example: 100

cursorstringOptional

base64-signed string

link_idstringOptional

Filter results to a specific trial link ID.

Example: 10668344

Responses

200

List of trial link users successfully retrieved for the specified platform account.

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/trial-link-users HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

List of trial link users successfully retrieved for the specified platform account.

{
  "items": [
    {
      "link_id": "text",
      "fan": {
        "id": "text",
        "name": "text",
        "username": "text"
      },
      "subscribed_at": "2026-05-21T08:37:26.158Z",
      "collected_at": "2026-05-21T08:37:26.158Z"
    }
  ],
  "cursor": "dHN4"
}

Retrieve chargebacks for a platform account

get

Rate limit: 15 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

platformstring · enumRequired

Name of the platform. Currently, only "onlyfans" is supported.

Example: onlyfansPossible values:

platform_account_idstringRequired

Unique account identifier returned by the OnlyFans platform.

Example: 000000000

Query parameters

startstring · date-timeRequired

Start of the chargeback creation timestamp range (ISO 8601 Zulu).

Example: 2025-10-01T00:00:00.000Z

endstring · date-timeRequired

End of the chargeback creation timestamp range (ISO 8601 Zulu).

Example: 2025-10-31T23:59:59.999Z

limitinteger · min: 10 · max: 1000Optional

Items per page (min:10 max:1000 default:100)

Default: 100

cursorstringOptional

base64-signed string

Responses

200

List of chargebacks successfully retrieved for the specified platform account.

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/chargebacks?start=2025-10-01T00%3A00%3A00.000Z&end=2025-10-31T23%3A59%3A59.999Z HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

List of chargebacks successfully retrieved for the specified platform account.

{
  "items": [
    {
      "id": "feab0694bd16cf2c83b372cede7fbe0b",
      "amount": 1,
      "fan": {
        "id": "000000000"
      },
      "type": "Tip from",
      "status": "undo",
      "chargeback_timestamp": "2025-08-05T14:50:07.000Z",
      "transaction_timestamp": "2025-08-05T12:01:42.000Z"
    },
    {
      "id": "3760ed0c1770ff18a663b3123acfab31",
      "amount": 16,
      "fan": {
        "id": "000000000"
      },
      "type": "Payment for message",
      "status": "undo",
      "chargeback_timestamp": "2025-07-31T09:05:13.000Z",
      "transaction_timestamp": "2025-07-28T04:02:27.000Z"
    }
  ],
  "cursor": "dHN4"
}

Retrieve transactions for a platform account

get

Rate limit: 15 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

platformstring · enumRequired

Name of the platform. Currently, only "onlyfans" is supported.

Example: onlyfansPossible values:

platform_account_idstringRequired

Unique account identifier returned by the OnlyFans platform.

Example: 000000000

Query parameters

startstring · date-timeRequired

Start of the transaction creation timestamp range (ISO 8601 Zulu).

Example: 2025-10-01T00:00:00.000Z

endstring · date-timeRequired

End of the transaction creation timestamp range (ISO 8601 Zulu).

Example: 2025-10-31T23:59:59.999Z

limitinteger · min: 10 · max: 1000Optional

Items per page (min:10 max:1000 default:100)

Default: 100

cursorstringOptional

base64-signed string

Responses

200

List of transactions successfully retrieved for the specified platform account.

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v0/platforms/{platform}/accounts/{platform_account_id}/transactions?start=2025-10-01T00%3A00%3A00.000Z&end=2025-10-31T23%3A59%3A59.999Z HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

List of transactions successfully retrieved for the specified platform account.

{
  "items": [
    {
      "id": "48098618fcb00ab1a84f280eb664d736",
      "amount": 50,
      "fan": {
        "id": "000000000"
      },
      "type": "Tip from",
      "status": "done",
      "timestamp": "2025-10-30T05:01:10.000Z"
    },
    {
      "id": "8f167af6c9fe857aec5968770e91df4d",
      "amount": 20,
      "fan": {
        "id": "000000000"
      },
      "type": "Payment for message",
      "status": "done",
      "timestamp": "2025-10-29T20:11:14.000Z"
    }
  ],
  "cursor": "dHN4"
}

Retrieve user metrics for OnlyFans platform

get

Rate limit: 15 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Query parameters

fromstring · date-timeRequired

Start of the metrics timestamp range (ISO 8601 Zulu).

Example: 2025-10-01T00:00:00.000Z

tostring · date-timeRequired

End of the metrics timestamp range (ISO 8601 Zulu).

Example: 2025-10-31T23:59:59.999Z

creator_idsinteger[] · min: 1 · max: 100Optional

Array of creator IDs to filter metrics by.

user_idsinteger[] · min: 1 · max: 100Optional

Array of user IDs to filter metrics by.

account_group_idintegerOptional

Account group ID to filter metrics by.

role_idintegerOptional

Role ID to filter metrics by.

offsetintegerRequired

Offset for pagination.

Default: 0

limitinteger · min: 1 · max: 100Required

Limit for pagination (max 100).

Default: 100

Responses

200

User metrics successfully retrieved.

application/json

get

/api/v0/users/metrics

HTTPcURLJavaScriptPython

GET /api/v0/users/metrics?from=2025-10-01T00%3A00%3A00.000Z&to=2025-10-31T23%3A59%3A59.999Z&offset=0&limit=100 HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

User metrics successfully retrieved.

{
  "items": [
    {
      "user_id": 123,
      "creator_ids": [
        456,
        789
      ],
      "fans_count": 150,
      "messages_count": 320,
      "template_messages_count": 50,
      "ai_generated_messages_count": 30,
      "copied_messages_count": 10,
      "media_messages_count": 100,
      "paid_messages_count": 25,
      "paid_messages_price_sum": 500.5,
      "words_count_sum": 5000,
      "unsent_messages_count": 5,
      "purchase_interval_avg": 3600,
      "reply_time_avg": 120,
      "posts_count": 45,
      "deleted_posts_count": 2,
      "work_time": 28800,
      "break_time": 3600,
      "sold_messages_count": 20,
      "sold_messages_price_sum": 400,
      "total_sold_messages_count": 50,
      "total_sold_messages_price_sum": 1000,
      "purchase_interval_min": 300,
      "purchase_interval_max": 7200,
      "sold_posts_count": 10,
      "sold_posts_price_sum": 200,
      "total_sold_posts_count": 25,
      "tips_amount_sum": 150,
      "total_tips_amount_sum": 300,
      "chargedback_tips_amount_sum": 10,
      "chargedback_posts_price_sum": 20,
      "chargedback_posts_count": 1,
      "chargedback_messages_price_sum": 15,
      "chargedback_messages_count": 1,
      "total_chargedback_tips_amount_sum": 25,
      "total_chargedback_posts_price_sum": 40,
      "total_chargedback_posts_count": 2,
      "total_chargedback_messages_price_sum": 30,
      "total_chargedback_messages_count": 2,
      "internal_templates_count": 15
    }
  ]
}

Retrieve organisation members

get

Rate limit: 15 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Query parameters

limitinteger · min: 1 · max: 50Required

Number of members to return (min: 1, max: 50).

Example: 20

offsetintegerRequired

Number of members to skip for pagination.

Example: 0

Responses

200

List of organisation members successfully retrieved.

application/json

get

/api/v0/members

HTTPcURLJavaScriptPython

GET /api/v0/members?limit=20&offset=0 HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

List of organisation members successfully retrieved.

{
  "users": [
    {
      "id": 1,
      "avatar": "https://example.com/avatar.jpg",
      "name": "Alice Johnson",
      "email": "[email protected]",
      "createdAt": "2025-01-15T09:00:00Z",
      "customName": "text"
    }
  ]
}

Retrieve vault folders for a platform account. (For OnlyFans account only)

get

Rate limit: 5 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

Query parameters

limitinteger · min: 1 · max: 10OptionalDefault: 10

offsetintegerOptionalDefault: 0

Responses

200

Default Response

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v0/accounts/{account_id}/vault/folders HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

Default Response

{
  "items": [
    {
      "id": 1,
      "type": "text",
      "name": "text",
      "has_media": true,
      "can_update": true,
      "can_delete": true,
      "videos_count": 1,
      "photos_count": 1,
      "gifs_count": 1,
      "audios_count": 1
    }
  ]
}

Retrieve medias from a vault folder. (For OnlyFans account only)

get

Rate limit: 5 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

folder_idstring · min: 1 · max: 100RequiredPattern: ^[0-9]+$

Query parameters

limitinteger · min: 1 · max: 10OptionalDefault: 10

offsetintegerOptionalDefault: 0

typestring · enumOptionalDefault: allPossible values:

Responses

200

Default Response

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v0/accounts/{account_id}/vault/folders/{folder_id}/medias HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

Default Response

{
  "items": [
    {
      "id": 1,
      "type": "text",
      "can_view": true,
      "is_ready": true,
      "has_error": true,
      "converted_to_video": true,
      "created_at": "text",
      "thumbnail_url": "text"
    }
  ]
}

Stream a media thumbnail from the vault. (For OnlyFans account only)

get

Rate limit: 3 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

media_idinteger · min: 1Required

Responses

200

Default Response

application/octet-stream

get

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

HTTPcURLJavaScriptPython

GET /api/v0/accounts/{account_id}/vault/media/{media_id}/thumbnail HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

Default Response

binary

List media uploads for a vault account.

get

Rate limit: 3 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

Query parameters

limitinteger · min: 1 · max: 100OptionalDefault: 10

offsetintegerOptionalDefault: 0

expiredbooleanOptional

Responses

200

Default Response

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v0/accounts/{account_id}/vault/medias/uploads HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

Default Response

{
  "items": [
    {
      "id": "text",
      "status": "uploaded",
      "media_id": "text",
      "metadata": {
        "name": "text",
        "size": 1,
        "content_type": "text",
        "duration": 1,
        "key": "text",
        "e_tag": "text",
        "get_url": "text",
        "export_type": "text",
        "export_fan_id": "text",
        "rf_guest": [
          "text"
        ],
        "rf_partner": [
          "text"
        ],
        "rf_tag": [
          "text"
        ]
      },
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "total": 1
}

Start a new vault media upload.

post

Rate limit: 3 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

Body

application/json

namestring · min: 1 · max: 255RequiredPattern: ^[\w. \-()]{1,255}$

sizeinteger · min: 1 · max: 5368709120Required

content_typestring · min: 1 · max: 255RequiredPattern: ^(image|video|audio)/[a-zA-Z0-9.+-]+$

durationnumberOptional

Responses

200

Default Response

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/v0/accounts/{account_id}/vault/medias/uploads/start HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "name": "text",
  "size": 1,
  "content_type": "text",
  "duration": 1
}

200

Default Response

{
  "get_url": "text",
  "put_url": "text",
  "key": "text"
}

Finish a multipart vault media upload.

post

Rate limit: 3 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

Body

application/json

keystring · min: 1 · max: 1024Required

upload_idstring · min: 1 · max: 256Required

Responses

200

Default Response

application/json

post

/api/v0/accounts/{account_id}/vault/medias/uploads/finish

HTTPcURLJavaScriptPython

POST /api/v0/accounts/{account_id}/vault/medias/uploads/finish HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "key": "text",
  "upload_id": "text",
  "parts": [
    {
      "part": 1,
      "e_tag": "text"
    }
  ]
}

200

Default Response

{
  "e_tag": "text"
}

Export an uploaded media to the vault.

post

Rate limit: 3 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

Body

application/json

namestring · min: 1 · max: 255RequiredPattern: ^[\w. \-()]{1,255}$

sizeinteger · min: 1 · max: 5368709120Required

content_typestring · min: 1 · max: 255RequiredPattern: ^(image|video|audio)/[a-zA-Z0-9.+-]+$

durationnumberOptional

keystring · min: 1 · max: 1024Required

e_tagstring · min: 1 · max: 256Required

get_urlstring · uri · min: 1 · max: 2048Required

export_typestring · enumRequiredPossible values:

export_fan_idstring · min: 1Optional

rf_gueststring[]Optional

rf_partnerstring[]Optional

rf_tagstring[]Optional

Responses

200

Default Response

application/json

post

/api/v0/accounts/{account_id}/vault/medias/uploads/export

HTTPcURLJavaScriptPython

POST /api/v0/accounts/{account_id}/vault/medias/uploads/export HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 223

{
  "name": "text",
  "size": 1,
  "content_type": "text",
  "duration": 1,
  "key": "text",
  "e_tag": "text",
  "get_url": "https://example.com",
  "export_type": "post",
  "export_fan_id": "text",
  "rf_guest": [
    "text"
  ],
  "rf_partner": [
    "text"
  ],
  "rf_tag": [
    "text"
  ]
}

200

Default Response

{
  "id": "text",
  "status": "uploaded",
  "media_id": "text",
  "metadata": {
    "name": "text",
    "size": 1,
    "content_type": "text",
    "duration": 1,
    "key": "text",
    "e_tag": "text",
    "get_url": "text",
    "export_type": "text",
    "export_fan_id": "text",
    "rf_guest": [
      "text"
    ],
    "rf_partner": [
      "text"
    ],
    "rf_tag": [
      "text"
    ]
  },
  "created_at": "text",
  "updated_at": "text"
}

Retry a failed vault media upload.

post

Rate limit: 3 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

upload_idstring · uuidRequired

Responses

200

Default Response

application/json

post

/api/v0/accounts/{account_id}/vault/medias/uploads/{upload_id}/retry

HTTPcURLJavaScriptPython

POST /api/v0/accounts/{account_id}/vault/medias/uploads/{upload_id}/retry HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Accept: */*

200

Default Response

{
  "id": "text",
  "status": "uploaded",
  "media_id": "text",
  "metadata": {
    "name": "text",
    "size": 1,
    "content_type": "text",
    "duration": 1,
    "key": "text",
    "e_tag": "text",
    "get_url": "text",
    "export_type": "text",
    "export_fan_id": "text",
    "rf_guest": [
      "text"
    ],
    "rf_partner": [
      "text"
    ],
    "rf_tag": [
      "text"
    ]
  },
  "created_at": "text",
  "updated_at": "text"
}

Verify a fan link before exporting vault media. (For OnlyFans account only)

post

Rate limit: 3 requests per second

Authorizations

ApiToken

x-om-auth-tokenstringRequired

API token for authentication

Path parameters

account_idstring · max: 19Required

Big integer id as string

Example: {"value":"1"}Pattern: ^(0|[1-9]\d*)$

Body

application/json

fan_linkstring · min: 1 · max: 2048RequiredPattern: ^https?://(www\.)?onlyfans\.com/

Responses

200

Default Response

application/json

post

/api/v0/accounts/{account_id}/vault/medias/uploads/fans/verify

HTTPcURLJavaScriptPython

POST /api/v0/accounts/{account_id}/vault/medias/uploads/fans/verify HTTP/1.1
Host: omapi.onlymonster.ai
x-om-auth-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "fan_link": "text"
}

200

Default Response

{
  "fan_id": "text"
}