media

Fluid SDK API Documentation (0.0.6)

OpenAPI documentation for Fluid's SDK API

Download OpenAPI description
public.json
public.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://fluid-commerce.redocly.app/_mock/docs/apis/public/
Production API server
https://api.fluid.app/
Local development server
https://api.fluid.test/

Orders

Operations

affiliate

Operations

carts

Operations

checkout

Operations

enrollment-packs

Operations

events

Operations

lead

Operations

page

Operations

url

Operations

fingerprint

Operations

media

Operations

Get media by slug

Request

Path
slugstringrequired

Media slug

Example: media-slug
Bodyapplication/json
metadataobject(RequestMetadata)required
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstring(/\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/)required
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​fluid_localestring(/\A[a-z]{2}_[A-Z]{2}\z/)
Example: "en_US"
metadata.​fluid_journeystring
metadata.​attributionAttributionEmail (object) or AttributionUsername (object) or AttributionSharedGuid (object) or AttributionFluidRepId (object) or AttributionExternalId (object)(Attribution)
Any of:
curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/public/api/public/v2025-06/media/{slug}' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

media retrieved successfully

Bodyapplication/json
statusnumberrequired
Example: 200
mediaobject(Medium)required
media.​idintegerrequired
media.​slugstring or null
media.​titlestringrequired
media.​kindstring or null
media.​media_typestringrequired
media.​media_formatstringrequired
media.​image_urlstring or null
media.​video_urlstring or null
media.​pdf_urlstring or null
media.​powerpoint_urlstring or null
media.​durationinteger or null
Default 0
media.​descriptionstringrequired
media.​subtitlesobject or null
Default "{}"
media.​comments_countintegerrequired
media.​productsArray of objects(Product)required
media.​products[].​idintegerrequired
media.​products[].​titlestringrequired
media.​products[].​image_urlstring or null
media.​products[].​image_pathstring or null
media.​products[].​pricenumber or string or null[ 0 .. 99999999 ]
Default "0.0"
media.​products[].​cvinteger or null
Default 0
media.​products[].​taxnumber or string or null
Default "0.0"
media.​products[].​skustring or null
media.​products[].​metadataobjectrequired
Default "{}"
media.​products[].​price_in_currencystringrequired
media.​products[].​tax_in_currencystringrequired
media.​products[].​cv_in_currencystringrequired
media.​enrollment_packsArray of objects(EnrollmentPack)required
media.​enrollment_packs[].​idintegerrequired
media.​enrollment_packs[].​titlestringrequired
media.​enrollment_packs[].​statusstringrequired
media.​enrollment_packs[].​image_urlstringrequired
metadataobject(ResponseMetadata)required
metadata.​fluid_shopstringrequired
metadata.​fluid_sessionstringrequired
metadata.​fluid_localestring or null(/\A[a-z]{2}_[A-Z]{2}\z/)
Example: "en_US"
metadata.​request_uuidstring(uuid)required
metadata.​timestampstringrequired
Response
application/json
{
  "status": 200,
  "media": {
    "id": 0,
    "slug": "string",
    "title": "string",
    "kind": "string",
    "media_type": "string",
    "media_format": "string",
    "image_url": "string",
    "video_url": "string",
    "pdf_url": "string",
    "powerpoint_url": "string",
    "duration": 0,
    "description": "string",
    "subtitles": "{}",
    "comments_count": 0,
    "products": [ … ],
    "enrollment_packs": [ … ]
  },
  "metadata": {
    "fluid_shop": "string",
    "fluid_session": "string",
    "fluid_locale": "en_US",
    "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8",
    "timestamp": "string"
  }
}

Get media by slug (deprecated)Deprecated

Request

Bodyapplication/json
mediaobjectrequired
media.​idstring

Media slug

Example: "test-media-slug"
metadataobject(RequestMetadata)required
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstring(/\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/)required
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​fluid_localestring(/\A[a-z]{2}_[A-Z]{2}\z/)
Example: "en_US"
metadata.​fluid_journeystring
metadata.​attributionAttributionEmail (object) or AttributionUsername (object) or AttributionSharedGuid (object) or AttributionFluidRepId (object) or AttributionExternalId (object)(Attribution)
Any of:
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/public/api/public/v2025-06/media \
  -H 'Content-Type: application/json' \
  -d '{
    "media": {
      "id": "test-media-slug"
    },
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

media retrieved successfully

Bodyapplication/json
statusnumberrequired
Example: 200
mediaobject(Medium)required
media.​idintegerrequired
media.​slugstring or null
media.​titlestringrequired
media.​kindstring or null
media.​media_typestringrequired
media.​media_formatstringrequired
media.​image_urlstring or null
media.​video_urlstring or null
media.​pdf_urlstring or null
media.​powerpoint_urlstring or null
media.​durationinteger or null
Default 0
media.​descriptionstringrequired
media.​subtitlesobject or null
Default "{}"
media.​comments_countintegerrequired
media.​productsArray of objects(Product)required
media.​products[].​idintegerrequired
media.​products[].​titlestringrequired
media.​products[].​image_urlstring or null
media.​products[].​image_pathstring or null
media.​products[].​pricenumber or string or null[ 0 .. 99999999 ]
Default "0.0"
media.​products[].​cvinteger or null
Default 0
media.​products[].​taxnumber or string or null
Default "0.0"
media.​products[].​skustring or null
media.​products[].​metadataobjectrequired
Default "{}"
media.​products[].​price_in_currencystringrequired
media.​products[].​tax_in_currencystringrequired
media.​products[].​cv_in_currencystringrequired
media.​enrollment_packsArray of objects(EnrollmentPack)required
media.​enrollment_packs[].​idintegerrequired
media.​enrollment_packs[].​titlestringrequired
media.​enrollment_packs[].​statusstringrequired
media.​enrollment_packs[].​image_urlstringrequired
metadataobject(ResponseMetadata)required
metadata.​fluid_shopstringrequired
metadata.​fluid_sessionstringrequired
metadata.​fluid_localestring or null(/\A[a-z]{2}_[A-Z]{2}\z/)
Example: "en_US"
metadata.​request_uuidstring(uuid)required
metadata.​timestampstringrequired
Response
application/json
{
  "status": 200,
  "media": {
    "id": 0,
    "slug": "string",
    "title": "string",
    "kind": "string",
    "media_type": "string",
    "media_format": "string",
    "image_url": "string",
    "video_url": "string",
    "pdf_url": "string",
    "powerpoint_url": "string",
    "duration": 0,
    "description": "string",
    "subtitles": "{}",
    "comments_count": 0,
    "products": [ … ],
    "enrollment_packs": [ … ]
  },
  "metadata": {
    "fluid_shop": "string",
    "fluid_session": "string",
    "fluid_locale": "en_US",
    "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8",
    "timestamp": "string"
  }
}

playlist

Operations

product

Operations

session

Operations

settings

Operations

widgets

Operations