Skip to main content
POST
Create multipart upload session for creator
Required scopes
  • write:creator — Modify creator profiles, settings, and creator-specific data.
  • write:media — Upload, modify, and manage media files and content assets. Also required for vault folder management.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Path Parameters

creatorUserUuid
string<uuid>
required

Body

application/json
name
string
required
Required string length: 1 - 255
filename
string
required
Required string length: 1 - 255
mediaType
enum<string>
required
Available options:
image,
video,
audio,
document
sizeBytes
integer

Total size of the file in bytes. When provided, the response includes the exact totalParts to upload.

Required range: x <= 1610612736

Response

Upload session created

mediaUuid
string<uuid>
required
uploadId
string
required
partSize
integer
required

Size in bytes of every part except the final one (which may be smaller).

maxParts
integer
required

Maximum number of parts allowed, derived from the maximum supported file size.

totalParts
integer | null
required

Exact number of parts to upload, computed from sizeBytes. Null when sizeBytes was not provided — compute it client-side as ceil(fileSize / partSize).