Skip to main content

Templates

Templates define the structure and behavior of digital twins in Filedgr.

Template Types

Standard Templates

  • Public templates covering common asset types
  • Define the streams every vault starts with
  • Supply a default image for vaults built from them

Custom Templates

Example template:

Template Fields

A template returned by the API carries:

FieldNotes
idUUID
name, description, authorDescriptive metadata
statusUPLOAD_PENDING · UPLOADED · DELETED · ERROR
publicWhether the template is listed for everyone
required_streamsStream names pre-created on every vault built from this template
default_image, default_image_cid, image_upload_urlTemplate imagery
configBehaviour flags, below

Configuration flags

config has exactly four boolean flags:

FlagEffect
is_permissionedVault access is governed by explicit permission grants
is_searchableVault is indexed for search
is_ai_readyVault content is prepared for AI retrieval
is_dynamic_streamsStreams may be added beyond required_streams
note

Templates are not versioned. There is no version field and no semantic-versioning scheme — updating a template with PUT /templates/{template_id} mutates it in place. Vaults already created from it keep the template snapshot that was deployed to IPFS at creation time.

IPFS

A template's default image is pinned to IPFS when the template is created, and the resulting default_image_cid is copied onto every vault built from it. The template record itself is not stored on IPFS.