Skip to content
Last updated

Understanding FID in Cincopa

What is FID?

In Cincopa, FID is the unique identifier of a gallery. It is a core identifier used by both the frontend embed code API and the backend API to load and present content in a consistent, contextualized way.

FID determines both what content is displayed (assets) and how it is presented (gallery layout, player, design, and customization).

Object Types in Cincopa

Cincopa works with two primary object types:

- Gallery: An ordered list of assets combined with a visual presentation. The presentation is based on a selected template and includes customization settings.
- Asset: An individual media file such as a video, image, audio clip, or document. Assets can appear in multiple galleries.

Types of Galleries

Cincopa supports multiple gallery types to support flexible visual configuration and reusability:

types-of-galleries

  1. Basic Gallery: Derives its visual from a built-in Cincopa template. Customizations are stored directly in the gallery.
  2. Master Gallery: Also uses a built-in Cincopa template. Designed to serve as a visual template for other galleries. When updated, all linked galleries that inherit from it are immediately updated visually.
  3. Linked Gallery: Inherits its visual configuration (template + customization) from a designated Master Gallery. Maintains its own separate list of assets. Cannot override visual settings independently.

FID Formats

FID formats define how galleries and assets are referenced when working with the Cincopa API, both on the frontend (embed code API) and the backend (REST or server-side API). They allow you to control the visual layout and the content separately, enabling flexible rendering and reuse patterns that go beyond the static Master/Linked gallery model.

1. Gallery FID

Format: {gallery_id}

Behavior: Loads the full gallery — both its visual configuration and its asset list.

Use Case: Embedding a complete gallery with its default styling and content.

2. Visual Gallery FID + Asset ID

Format: {visual_gallery_id}!{asset_id}

Behavior: Uses the visual layout and template from the gallery (visual_gallery_id) and dynamically injects a specific asset (asset_id). The asset does not need to be part of the gallery’s asset list.

To learn more about this format and how to use it with different templates, refer to the FID Use Cases section.

note
This format allows dynamic composition of content and presentation without using the Master/Linked gallery mechanism. The (visual_gallery_id) refers to a regular gallery, and only its visual configuration will be used.

3. Visual Gallery FID + Content Gallery FID

Format: {visual_gallery_id}@{content_gallery_id}

Behavior: Uses the visual configuration from the left-hand gallery and the asset list from the right-hand gallery.

To learn more about this format and how to use it with different templates, refer to the FID Use Cases section.

note
Like the previous format, this allows separation of visual layout and content without relying on a Master/Linked structure. Both galleries are regular galleries, and only the visual from the first and the assets from the second will be used.

Summary of FID Formats

FormatVisual FromContent FromDescription
{gallery_id}gallery_idgallery_idFull gallery usage
{visual_gallery_id}!{asset_id}visual_gallery_idasset_idSingle asset with reused gallery visual
{visual_gallery_id}@{content_gallery_id}visual_gallery_idcontent_gallery_idReuse visual layout with different content set

Cincopa FID Usage Examples

1. Template ID + Gallery ID (@)

This use case allows you to reuse a gallery’s design while displaying content from another gallery. By combining a Template ID (visual layout) and a Gallery ID (media content) using the (@) symbol, Cincopa loads the content from the gallery and applies the template's design.

  • Template ID: Provides the layout, styling, and visual configuration.

  • Gallery ID: Provides the actual media assets (such as videos, images, and audio).

  • Result: Your gallery’s content is displayed using the chosen template’s design, without modifying the original template or content gallery.

This approach is ideal when you want consistent styling across multiple galleries while keeping the content separate.

2. Template ID + Asset ID (!)

This use case allows you to display a single asset using the design of a template gallery. By combining a Template ID (visual layout) and an Asset ID (specific media file) using the (!) symbol, Cincopa applies the template’s design to the selected asset.

  • Template ID: provides the layout, styling, and visual configuration.

  • Asset ID: specifies the single media file to display (video, image, or audio).

  • Result: The chosen asset is presented using the template’s design, without affecting the original gallery or template.

This approach is ideal when you want to highlight a specific video or image while maintaining consistent styling from a pre-defined template.

Video Playlist Templates

Template IDAcNAER78NK3w
Template UsedVideo with horizontal playlist
Gallery ID (Example)AkMAesf2-UKY
FormatAcNAER78NK3w@AkMAesf2-UKY
<div id="cincopa_4ff7f5">...</div><script type="text/javascript">
var cpo = []; cpo["_object"] ="cincopa_4ff7f5"; cpo["_fid"] = "AcNAER78NK3w@AkMAesf2-UKY";
var _cpmp = _cpmp || []; _cpmp.push(cpo);
(function() { var cp = document.createElement("script"); cp.type = "text/javascript";
cp.async = true; cp.src = "https://rtcdn.cincopa.com/libasync.js";
var c = document.getElementsByTagName("script")[0];
c.parentNode.insertBefore(cp, c); })(); </script>

Video with horizontal playlist

Template IDAQOAmHOtTxyF
Template UsedVideo Academy Template
Gallery ID (Example)AkMAesf2-UKY
FormatAQOAmHOtTxyF@AkMAesf2-UKY
<div id="cincopa_4ff7f5">...</div><script type="text/javascript">
var cpo = []; cpo["_object"] ="cincopa_4ff7f5"; cpo["_fid"] = "AQOAmHOtTxyF@AkMAesf2-UKY";
var _cpmp = _cpmp || []; _cpmp.push(cpo);
(function() { var cp = document.createElement("script"); cp.type = "text/javascript";
cp.async = true; cp.src = "https://rtcdn.cincopa.com/libasync.js";
var c = document.getElementsByTagName("script")[0];
c.parentNode.insertBefore(cp, c); })(); </script>

Video-Academy-Template

Template IDAMJAxPukGGLo
Template UsedSpree Video Playlist
Gallery ID (Example)AkMAesf2-UKY
FormatAMJAxPukGGLo@AkMAesf2-UKY
<div id="cincopa_4ff7f5">...</div><script type="text/javascript">
var cpo = []; cpo["_object"] ="cincopa_4ff7f5"; cpo["_fid"] = "AMJAxPukGGLo@AkMAesf2-UKY";
var _cpmp = _cpmp || []; _cpmp.push(cpo);
(function() { var cp = document.createElement("script"); cp.type = "text/javascript";
cp.async = true; cp.src = "https://rtcdn.cincopa.com/libasync.js";
var c = document.getElementsByTagName("script")[0];
c.parentNode.insertBefore(cp, c); })(); </script>

Spree-Video-Playlist

Grid (Videos & Images) Templates

For Image

Template IDA4IA-RbWMFlu
Template UsedResponsive imagelist
Gallery ID (Example)A0OAJv_2bV5R
FormatA4IA-RbWMFlu@A0OAJv_2bV5R
<div id="cincopa_6052b8">...</div><script type="text/javascript">
var cpo = []; cpo["_object"] ="cincopa_6052b8"; cpo["_fid"] = "A4IA-RbWMFlu@A0OAJv_2bV5R";
var _cpmp = _cpmp || []; _cpmp.push(cpo);
(function() { var cp = document.createElement("script"); cp.type = "text/javascript";
cp.async = true; cp.src = "https://rtcdn.cincopa.com/libasync.js";
var c = document.getElementsByTagName("script")[0];
c.parentNode.insertBefore(cp, c); })(); </script>

Responsive-imagelist

Template IDAwGApb7BSpUq
Template UsedPinterest style gallery with rounded thumbs
Gallery ID (Example)A0OAJv_2bV5R
FormatAwGApb7BSpUq@A0OAJv_2bV5R
<div id="cincopa_6052b8">...</div><script type="text/javascript">
var cpo = []; cpo["_object"] ="cincopa_6052b8"; cpo["_fid"] = "AwGApb7BSpUq@A0OAJv_2bV5R";
var _cpmp = _cpmp || []; _cpmp.push(cpo);
(function() { var cp = document.createElement("script"); cp.type = "text/javascript";
cp.async = true; cp.src = "https://rtcdn.cincopa.com/libasync.js";
var c = document.getElementsByTagName("script")[0];
c.parentNode.insertBefore(cp, c); })(); </script>

Pinterest-style-gallery-with-rounded-thumbs

For Video

Template IDA4IA-RbWMFlu
Template UsedResponsive imagelist
Gallery ID (Example)AkMAesf2-UKY
FormatA4IA-RbWMFlu@AkMAesf2-UKY
<div id="cincopa_6052b8">...</div><script type="text/javascript">
var cpo = []; cpo["_object"] ="cincopa_6052b8"; cpo["_fid"] = "A4IA-RbWMFlu@AkMAesf2-UKY";
var _cpmp = _cpmp || []; _cpmp.push(cpo);
(function() { var cp = document.createElement("script"); cp.type = "text/javascript";
cp.async = true; cp.src = "https://rtcdn.cincopa.com/libasync.js";
var c = document.getElementsByTagName("script")[0];
c.parentNode.insertBefore(cp, c); })(); </script>

fid-images/Responsive-imagelist1

Template IDAwGApb7BSpUq
Template UsedPinterest style gallery with rounded thumbs
Gallery ID (Example)AkMAesf2-UKY
FormatAwGApb7BSpUq@AkMAesf2-UKY
<div id="cincopa_6052b8">...</div><script type="text/javascript">
var cpo = []; cpo["_object"] ="cincopa_6052b8"; cpo["_fid"] = "AwGApb7BSpUq@AkMAesf2-UKY";
var _cpmp = _cpmp || []; _cpmp.push(cpo);
(function() { var cp = document.createElement("script"); cp.type = "text/javascript";
cp.async = true; cp.src = "https://rtcdn.cincopa.com/libasync.js";
var c = document.getElementsByTagName("script")[0];
c.parentNode.insertBefore(cp, c); })(); </script>

Pinterest-style-gallery-with-rounded-thumbs

Using a Different Template with Asset ID

Video Playlist Templates

Template IDAcNAER78NK3w
Template UsedVideo with horizontal playlist
Asset ID (Example)AkMAesf2-UKY
FormatAcNAER78NK3w!AkMAesf2-UKY
<div id="cincopa_A4HAcLOLOO68AoLDmW_1P59n" class="cincopa-fadein" >
            <div style='width: 100%; height: auto; max-width: 100%; display:flex;'>
            	<img src="https://rtcdn.cincopa.com/thumb.aspx?fid=AcNAER78NK3w!AoLDmW_1P59n&size=large" 
            	style="filter:blur(5px); object-fit:contain; width:100%; padding: 0; margin: 0; aspect-ratio: 1.78; padding: 0; margin: 0;" onload="this.parentNode ? this.parentNode.style.opacity=1 : '';" />
            </div>
</div>
<script src="//rtcdn.cincopa.com/meta_json.aspx?fid=AcNAER78NK3w!AoLDmW_1P59n&ver=v2&id=cincopa_A4HAcLOLOO68AoLDmW_1P59n" type="text/javascript"></script>
            
<script src="//rtcdn.cincopa.com/libasync.js" type="text/javascript"></script>

Video-with-horizontal-playlist

Template IDAQOAmHOtTxyF
Template UsedVideo Academy Template
Gallery ID (Example)AkMAesf2-UKY
FormatAQOAmHOtTxyF!AkMAesf2-UKY
<div id="cincopa_A4HAcLOLOO68AoLDmW_1P59n" class="cincopa-fadein" >
            <div style='width: 100%; height: auto; max-width: 100%; display:flex;'>
            	<img src="https://rtcdn.cincopa.com/thumb.aspx?fid=AQOAmHOtTxyF!AoLDmW_1P59n&size=large" 
            	style="filter:blur(5px); object-fit:contain; width:100%; padding: 0; margin: 0; aspect-ratio: 1.78; padding: 0; margin: 0;" onload="this.parentNode ? this.parentNode.style.opacity=1 : '';" />
            </div>
</div>
<script src="//rtcdn.cincopa.com/meta_json.aspx?fid=AQOAmHOtTxyF!AoLDmW_1P59n&ver=v2&id=cincopa_A4HAcLOLOO68AoLDmW_1P59n" type="text/javascript"></script>
            
<script src="//rtcdn.cincopa.com/libasync.js" type="text/javascript"></script>

Video-Academy-Template

Template IDAMJAxPukGGLo
Template UsedSpree Video Playlist
Asset ID (Example)AoLDmW_1P59n
FormatAMJAxPukGGLoAkMAesf2-UKY
<div id="cincopa_A4HAcLOLOO68AoLDmW_1P59n" class="cincopa-fadein" >
            <div style='width: 100%; height: auto; max-width: 100%; display:flex;'>
            	<img src="https://rtcdn.cincopa.com/thumb.aspx?fid=AMJAxPukGGLo!AoLDmW_1P59n&size=large" 
            	style="filter:blur(5px); object-fit:contain; width:100%; padding: 0; margin: 0; aspect-ratio: 1.78; padding: 0; margin: 0;" onload="this.parentNode ? this.parentNode.style.opacity=1 : '';" />
            </div>
</div>
<script src="//rtcdn.cincopa.com/meta_json.aspx?fid=AMJAxPukGGLo!AoLDmW_1P59n&ver=v2&id=cincopa_A4HAcLOLOO68AoLDmW_1P59n" type="text/javascript"></script>
            
<script src="//rtcdn.cincopa.com/libasync.js" type="text/javascript"></script>

Spree-Video-Playlist

Grid (Videos & Images) Templates

For Image

Template IDA4IA-RbWMFlu
Template UsedResponsive imagelist
Asset ID (Example)AoJDzYfDkvlT
FormatA4IA-RbWMFlu!AoJDzYfDkvlT
<div id="cincopa_A4HAcLOLOO68AoLDmW_1P59n" class="cincopa-fadein" >
            <div style='width: 100%; height: auto; max-width: 100%; display:flex;'>
            	<img src="https://rtcdn.cincopa.com/thumb.aspx?fid=A4IA-RbWMFlu!AoJDzYfDkvlT&size=large" 
            	style="filter:blur(5px); object-fit:contain; width:100%; padding: 0; margin: 0; aspect-ratio: 1.78; padding: 0; margin: 0;" onload="this.parentNode ? this.parentNode.style.opacity=1 : '';" />
            </div>
</div>
<script src="//rtcdn.cincopa.com/meta_json.aspx?fid=A4IA-RbWMFlu!AoJDzYfDkvlT&ver=v2&id=cincopa_A4HAcLOLOO68AoLDmW_1P59n" type="text/javascript"></script>
            
<script src="//rtcdn.cincopa.com/libasync.js" type="text/javascript"></script>

Responsive-imagelist

For Video

Template IDA4IA-RbWMFlu
Template UsedResponsive imagelist
Gallery ID (Example)AkMAesf2-UKY
FormatA4IA-RbWMFlu@AkMAesf2-UKY
<div id="cincopa_A4HAcLOLOO68AoLDmW_1P59n" class="cincopa-fadein" >
            <div style='width: 100%; height: auto; max-width: 100%; display:flex;'>
            	<img src="https://rtcdn.cincopa.com/thumb.aspx?fid=A4IA-RbWMFlu!AoLDmW_1P59n&size=large" 
            	style="filter:blur(5px); object-fit:contain; width:100%; padding: 0; margin: 0; aspect-ratio: 1.78; padding: 0; margin: 0;" onload="this.parentNode ? this.parentNode.style.opacity=1 : '';" />
            </div>a
</div>
<script src="//rtcdn.cincopa.com/meta_json.aspx?fid=A4IA-RbWMFlu!AoLDmW_1P59n&ver=v2&id=cincopa_A4HAcLOLOO68AoLDmW_1P59n" type="text/javascript"></script>
            
<script src="//rtcdn.cincopa.com/libasync.js" type="text/javascript"></script>

Responsive-imagelist