> ## Documentation Index
> Fetch the complete documentation index at: https://api.fanvue.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a media link

> Create a shareable media link that bundles one or more vault media items for a single unlock price. All referenced media must be owned by the creator. Amounts are integer minor units of the currency (e.g. cents: 1999 = $19.99). Requires media links to be enabled.

<Info>
  **Required scope**

  * `write:creator` — Modify creator profiles, settings, and creator-specific data.
</Info>


## OpenAPI

````yaml /openapi.json post /media-links
openapi: 3.1.0
info:
  title: Fanvue API
  version: '0.1'
servers: []
security: []
paths:
  /media-links:
    post:
      summary: Create a media link
      description: >-
        Create a shareable media link that bundles one or more vault media items
        for a single unlock price. All referenced media must be owned by the
        creator. Amounts are integer minor units of the currency (e.g. cents:
        1999 = $19.99). Requires media links to be enabled.
      operationId: createMediaLink
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                mediaUuids:
                  type: array
                  items:
                    type: string
                    format: uuid
                  minItems: 1
                  description: >-
                    UUIDs of the vault media items to bundle into the link. All
                    must be owned by the creator.
                price:
                  type: integer
                  minimum: 300
                  maximum: 50000
                  description: >-
                    Price fans pay to unlock the media, in integer minor units
                    of the currency (e.g. cents: 1999 = $19.99). Must be between
                    300 and 50000 minor units. Note: the Fanvue dashboard
                    displays prices in major units; this API always uses integer
                    minor units.
              required:
                - mediaUuids
                - price
      responses:
        '201':
          description: Media link created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                    description: Media link UUID
                  url:
                    type:
                      - string
                      - 'null'
                    description: Shareable URL fans use to unlock the media
                  price:
                    type: integer
                    description: >-
                      Price in integer minor units of the currency (e.g. cents)
                      fans pay to unlock
                  mediaUuids:
                    type: array
                    items:
                      type: string
                      format: uuid
                    description: >-
                      UUIDs of the media items bundled into the link, oldest
                      first
                  clicks:
                    type: integer
                    description: Number of times the link has been viewed
                  unlocks:
                    type: integer
                    description: Number of paid unlocks (completed purchases)
                  earnings:
                    type: integer
                    description: >-
                      Total gross earnings from the link, in integer minor units
                      of the currency
                  createdAt:
                    type: string
                    format: date-time
                    description: When the link was created
                required:
                  - uuid
                  - url
                  - price
                  - mediaUuids
                  - clicks
                  - unlocks
                  - earnings
                  - createdAt
              example:
                uuid: b3c4d5e6-7f8a-4b9c-8d0e-1f2a3b4c5d6e
                url: https://www.fanvue.com/creatorhandle/media/fvml-12
                price: 1999
                mediaUuids:
                  - c4d5e6f7-8a9b-4c0d-9e1f-2a3b4c5d6e7f
                  - d5e6f7a8-9b0c-4d1e-af2a-3b4c5d6e7f8a
                clicks: 128
                unlocks: 14
                earnings: 27986
                createdAt: '2024-01-15T00:00:00.000Z'
        '400':
          description: Bad Request - API version not supported OR validation failed
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/UnsupportedVersionError'
                  - $ref: '#/components/schemas/ValidationError'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '403':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '410':
          $ref: '#/components/responses/SunsetVersionResponse'
        '429':
          $ref: '#/components/responses/RateLimitResponse'
      security:
        - BearerAuth:
            - write:creator
components:
  parameters:
    ApiVersionHeader:
      name: X-Fanvue-API-Version
      in: header
      required: true
      schema:
        type: string
        default: '2025-06-26'
        example: '2025-06-26'
      description: API version to use for the request
  schemas:
    UnsupportedVersionError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      description: API version not supported
    ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
      required:
        - errors
      description: Request validation failed
  responses:
    UnauthorizedResponse:
      description: Unauthorized Response
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
    NotFoundResponse:
      description: Not Found Response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
            required:
              - message
    SunsetVersionResponse:
      description: API version no longer supported (sunset)
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              message:
                type: string
              nextVersion:
                type: string
            required:
              - error
              - message
    RateLimitResponse:
      description: Too many requests - rate limit exceeded
      headers:
        Retry-After:
          description: Number of seconds to wait before retrying the request
          schema:
            type: integer
        X-RateLimit-Limit:
          description: The maximum number of requests allowed in the current window
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: The number of requests remaining in the current window
          schema:
            type: integer
        X-RateLimit-Reset:
          description: The Unix timestamp (seconds) when the rate limit window resets
          schema:
            type: integer
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
  securitySchemes:
    BearerAuth:
      type: oauth2
      description: >-
        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.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.fanvue.com/oauth2/auth
          tokenUrl: https://auth.fanvue.com/oauth2/token
          refreshUrl: https://auth.fanvue.com/oauth2/token
          scopes:
            read:self: >-
              Access your own user profile information, including basic account
              details and settings.
            read:chat: >-
              Read chat conversations, messages, and chat-related data. This
              includes viewing chat lists and message history.
            write:chat: >-
              Create new chats and send messages. This scope is required for any
              chat-related actions that modify data.
            read:experience: >-
              Exchange a fan's experience token for the resolved experience and
              the fan's identity, so an embedded fan-facing experience can
              render the right content.
            write:experience: >-
              Request that the creator publish or unpublish a fan-facing
              experience. The app mints a request token; the creator confirms
              and Fanvue performs the change.
            read:fan: Access fan-related data and information within the platform.
            read:post: Read posts, including post details, comments, likes, and tips.
            write:post: Create, edit, and manage posts and content on behalf of users.
            read:media: Access media files, images, videos, and other content assets.
            write:media: >-
              Upload, modify, and manage media files and content assets. Also
              required for vault folder management.
            read:creator: >-
              Access creator profiles, content, and creator-specific
              information.
            write:creator: Modify creator profiles, settings, and creator-specific data.
            read:insights: >-
              Access analytics, metrics, and insights data for performance
              tracking.
            read:tracking_links: >-
              Read tracking links and the users associated with them, including
              per-user tracking metadata.
            write:tracking_links: Create and delete tracking links.
            read:agency: Read agency information, including the agency's team members.
            write:agency: >-
              Manage agency team members and invites, including inviting new
              team members and creators.

````