Skip to main content
GET
Get media by UUID
Required scope
  • read:media — Access media files, images, videos, and other content assets.

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

uuid
string<uuid>
required

Query Parameters

purchasedBy
string<uuid>

UUID of the user to check media purchase against. When provided, the media item will include a purchasedByFan boolean indicating if that user has purchased it.

variants
enum<string>[]

Comma-separated list of media variant types

The type of media variant

Available options:
blurred,
main,
thumbnail,
thumbnail_gallery

Response

Media item

uuid
string<uuid>
required
status
enum<string>
required
Available options:
created,
processing,
ready,
error
errorReason
enum<string>

Why processing failed. Present only when status is error. unsupported_format means the uploaded bytes are not a readable file of the declared type: check that each part is PUT as the raw file bytes, not form-data, base64 or a redirect page. processing_failed covers every other failure.

Available options:
unsupported_format,
video_too_long,
document_too_large,
pdf_invalid,
pdf_password_protected,
pdf_page_limit_exceeded,
processing_failed