Skip to main content

Template Package Manifest

The Template Package manifest is a json file that specifies what data should be created or updated when a template is deployed, and how that data should be deployed.

There is a direct connection between between the information in the manifest and the structure of the package file. For instance, the config, omapiConfig, and scripts fields in the sample manifest below relate directly to the config, omapiConfig, and scripts folders in the package.

// manifest.json{   "Template Name": "",   "Template Version": "",   "configs": [],   "omapiConfig": [],   "scripts": [],   "files": [],   "mcpTools": [],   "agents": [],   "teams": [],   "workflows": [],   "userGroups": [],   "userGroupToUserConfig": []}

Manifest Specification#

The Manifest Specification defines the fields that may be used in a manifest.json. Any fields found in a manifest.json that are not included in the manifest specification will result in the template package not being deployed.

The manifest currently requires:

The manifest currently supports optional deployment of:

Template Packages also support extensibility and supports deploying more than what the manifest specification supports. See Extending the Template Package for more information.

Manifest Deployment Order#

To ensure successful deployment of Template Package materials, items configured in the manifest are deployed in this order:

  1. Initialize Script
  2. Scripts
  3. User Configs
  4. API Configs
  5. File Upload With Tags (and file-linked KnowledgeBases)
  6. Custom MCP Tools
  7. Agents
  8. Teams
  9. Workflows
  10. User Groups
  11. User Group to User Config Associations
  12. Orchestrators
  13. NamedUserCollections
  14. Item Import
  15. Setup Script

This order ensures that if a later deploy step requires other items—for example a User Group to User Config Association requires a user group and a user config, or a workflow AI_CONVERSE task requires a team—that the preceding items will have already been created.