Get media by slug (deprecated)

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

Servers

Mock server

https://docs.fluid.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://docs.fluid.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.settingsobject or null

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[].introductionstring or null

media.products[].price_in_currencystringrequired

media.products[].tax_in_currencystringrequired

media.products[].cv_in_currencystringrequired

media.products[].metafieldsArray of objects(LegacyMetafield)required

media.products[].metafields[].idintegerrequired

media.products[].metafields[].namespacestring<= 20 characters\A[a-zA-Z0-9_]+\zrequired

A container for related metafields. Commonly used to group metafields by app or functionality.

Example: "custom"

media.products[].metafields[].keystring<= 30 characters\A[a-zA-Z0-9_]+\zrequired

The unique identifier for the metafield within its namespace. Must be unique per namespace and owner.

Example: "material"

media.products[].metafields[].valuestring or objectrequired

The actual data stored in the metafield. Type depends on value_type.

Example: "cotton"

media.products[].metafields[].value_typestringrequired

The data type that defines how the value should be interpreted and validated.

Example: "single_line_text_field"

media.products[].metafields[].descriptionstring or null

Optional human-readable description explaining the purpose of this metafield.

Example: "The primary material used in this product"

media.products[].metafields[].owner_typestringrequired

The type of resource that this metafield belongs to (polymorphic association).

Example: "Product"

media.products[].metafields[].owner_idintegerrequired

The ID of the specific resource that this metafield belongs to.

Example: 12345

media.products[].metafields[].created_atstring(date-time)required

Timestamp when the metafield was created.

Example: "2021-01-01T00:00:00Z"

media.products[].metafields[].updated_atstring(date-time)required

Timestamp when the metafield was last updated.

Example: "2021-01-01T00:00:00Z"

media.products[].metafields[].metafield_definitionobject or null(MetafieldDefinition)

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,
    "settings": {},
    "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://docs.fluid.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.settingsobject or null

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[].introductionstring or null

media.products[].price_in_currencystringrequired

media.products[].tax_in_currencystringrequired

media.products[].cv_in_currencystringrequired

media.products[].metafieldsArray of objects(LegacyMetafield)required

media.products[].metafields[].idintegerrequired

media.products[].metafields[].namespacestring<= 20 characters\A[a-zA-Z0-9_]+\zrequired

A container for related metafields. Commonly used to group metafields by app or functionality.

Example: "custom"

media.products[].metafields[].keystring<= 30 characters\A[a-zA-Z0-9_]+\zrequired

The unique identifier for the metafield within its namespace. Must be unique per namespace and owner.

Example: "material"

media.products[].metafields[].valuestring or objectrequired

The actual data stored in the metafield. Type depends on value_type.

Example: "cotton"

media.products[].metafields[].value_typestringrequired

The data type that defines how the value should be interpreted and validated.

Example: "single_line_text_field"

media.products[].metafields[].descriptionstring or null

Optional human-readable description explaining the purpose of this metafield.

Example: "The primary material used in this product"

media.products[].metafields[].owner_typestringrequired

The type of resource that this metafield belongs to (polymorphic association).

Example: "Product"

media.products[].metafields[].owner_idintegerrequired

The ID of the specific resource that this metafield belongs to.

Example: 12345

media.products[].metafields[].created_atstring(date-time)required

Timestamp when the metafield was created.

Example: "2021-01-01T00:00:00Z"

media.products[].metafields[].updated_atstring(date-time)required

Timestamp when the metafield was last updated.

Example: "2021-01-01T00:00:00Z"

media.products[].metafields[].metafield_definitionobject or null(MetafieldDefinition)

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,
    "settings": {},
    "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

Fluid SDK API Documentation (0.0.6)

Orders

affiliate

carts

checkout

enrollment-packs

events

lead

page

url

fingerprint

media

Get media by slug

Request

Responses

Was this helpful?

Get media by slug (deprecated)Deprecated

Request

Responses

Was this helpful?

playlist

product

session

settings

widgets

Fluid SDK API Documentation (0.0.6)

Orders

affiliate

carts

checkout

enrollment-packs

events

lead

page

url

fingerprint

media

Get media by slug

RequestExpand all

Responses

Was this helpful?

Get media by slug (deprecated)Deprecated

RequestExpand all

Responses

Was this helpful?

playlist

product

session

settings

widgets

Request

Request