Fanvue API Documentation

curl -G https://api.fanvue.com/media/uuid/entitled \
     -H "X-Fanvue-API-Version: 2025-06-26" \
     -H "Authorization: Bearer <token>" \
     -d consumerId=consumerId

{
  "uuid": "d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
  "status": "ready",
  "createdAt": "2024-01-15T00:00:00.000Z",
  "caption": "Sunset at the beach",
  "description": null,
  "name": "beach-sunset.jpg",
  "mediaType": "image",
  "recommendedPrice": null,
  "variants": [
    {
      "uuid": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
      "variantType": "main",
      "displayPosition": 0,
      "url": "https://media.fanvue.com/main/d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a.jpg",
      "width": 3840,
      "height": 2160,
      "lengthMs": null
    },
    {
      "uuid": "d0e1f2a3-4b5c-6d7e-8f9a-0b1c2d3e4f5a",
      "variantType": "thumbnail",
      "displayPosition": 1,
      "url": "https://media.fanvue.com/thumb/d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a.jpg",
      "width": 320,
      "height": 180,
      "lengthMs": null
    },
    {
      "uuid": "e1f2a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b",
      "variantType": "thumbnail_gallery",
      "displayPosition": 2,
      "url": "https://media.fanvue.com/gallery/d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a.jpg",
      "width": 400,
      "height": 300,
      "lengthMs": null
    },
    {
      "uuid": "f2a3b4c5-6d7e-8f9a-0b1c-2d3e4f5a6b7c",
      "variantType": "blurred",
      "displayPosition": 3,
      "url": "https://media.fanvue.com/blur/d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a.jpg",
      "width": 3840,
      "height": 2160,
      "lengthMs": null
    }
  ]
}

Returns a media item with signed variant URLs, but only if the specified consumer has been granted access via a prior grant call.

Media URLs are only available through variants. Specify the variants query parameter (e.g., ?variants=main,thumbnail) to include them in the response.

Scope required: read:media

Returns a media item with signed variant URLs, but only if the specified consumer has been granted access via a prior grant call. <Warning>Media URLs are only available through variants. Specify the `variants` query parameter (e.g., `?variants=main,thumbnail`) to include them in the response.</Warning> <Info>Scope required: `read:media`</Info>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

uuidstringRequiredformat: "uuid"

Query parameters

consumerIdstringRequiredformat: "uuid"

UUID of the consumer whose entitlement to verify

variantslist of enumsOptional

Allowed values:

Response

Media item with signed variant URLs

object

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

410

Gone Error

429

Too Many Requests Error

Get media for an entitled consumer