Substy Developers
Media and vault

List vault media

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.

GET/v1/agencies/{agencyId}/creators/{creatorId}/vault/media

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.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
creatorId*string

Query Parameters

limit?never
searchTerm?string
type?|array<>
cursor?string
listId?string
sortOrder?string

Value in

  • "newest"
  • "oldest"
hasScripts?boolean
fanId?string
Length1 <= length
statuses?array<>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/creators/string/vault/media" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "medias": [      {        "id": "string",        "price": 0,        "type": "PHOTO",        "isSoloPpv": true,        "basePrice": 0,        "maxPrice": 0,        "tags": [          "string"        ],        "lists": [          {            "id": "string",            "name": "string"          }        ],        "files": {          "preview": "string",          "thumb": "string",          "full": "string"        },        "creatorTags": [          "string"        ],        "createdAt": "string",        "context": null,        "contextStatus": null,        "duration": null,        "hasScripts": null,        "alreadySent": null,        "alreadyOpened": null,        "position": null,        "isPreview": null,        "messageTemplates": null,        "scriptNames": null,        "messageTemplateNames": null,        "isReady": null,        "isUploading": null,        "purchasedByFan": null,        "contentAccess": {          "tool": "media__read",          "arguments": {            "agencyId": "string",            "input": {              "creatorId": "string",              "mediaId": "string",              "variant": "full"            }          },          "variants": [            "full"          ],          "note": "string"        }      }    ],    "hasMore": true,    "nextCursor": null,    "historyStatus": null  },  "meta": {    "requestId": "string"  }}

Update vault media PATCH

Update a creator vault media record using the supplied media metadata.

Delete vault media DELETE

Delete the selected media items from the creator's vault using their media IDs.