Snapshots - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

Updated in 2026.14 A Snapshot is an immutable version of a Project that you can use to publish AI Agents through Endpoints. Snapshots are intended for production. They offer maximum performance and aren’t affected by changes in the Project configuration. You can also download a Snapshot as a Cognigy Snapshot file. Snapshots files have a .csnap extension and can be used only in Cognigy.AI. Also, they are encrypted because they may include sensitive information, such as data in Connections. You can use Snapshots for the following purposes:

• Deploy an AI Agent version through Endpoints and use it as the production version while your developers work on the next version.
• Back up your AI Agent in case you need to return to the back up one.
• Transfer an AI Agent between different CI/CD environments.

A Snapshot includes the following resources:

• AI Agents
• Connections
• Extensions
• Flows
• Functions
• Handover Providers
• Large Language Models
• Lexicons
• Localization
• Natural Language Understanding (NLU) Connectors
• Playbooks
• Settings
• Tokens
• Trained NLU Intent models

Restrictions

• Snapshots don’t include the following resources:
  • Endpoints
  • Intent Trainer records
  • Analytics data
  • Contact Profiles
  • Logs
  • Knowledge AI
  • Other Snapshots
• The text-embedding-3-model model increases the size of Snapshots, leading to longer download and upload times.
• Earlier versions of Cognigy.AI might not support Snapshots created in newer versions and can cause unexpected errors.
• Snapshot creation fails with an error if any JSON key in the Project’s data contains a period (.). Periods are reserved for dot notation used to access nested properties in Cognigy.AI, for example, context.user.name. Avoid using periods in JSON keys across all Cognigy.AI resources and other data included in the Snapshot.

Limitations

• You can create up to 10 Snapshots per AI Agent. For on-premises installations, you can change this value using the MAX_AMOUNT_SNAPSHOTS_IN_AGENT environment variable in values.yaml.
• A Snapshot can be up to 2 GB. If a Snapshot exceeds this limit, you can’t create or upload it. For on-premises installations, you can increase the maximum size by setting the SNAPSHOT_MAX_FILE_SIZE environment variable in values.yaml.
• You have up to 1 day to download a Snapshot after you’ve prepared the download. After this period, you need to prepare the download again.

Working with Snapshots

Important Warning

If you delete a Snapshot that you use with an Endpoint in production, the AI Agent connected to that Endpoint stops working.

• GUI

• API

• CLI

You can create, delete, and restore Snapshots in Deploy > Snapshots. Additionally, you can download and upload Snapshots:

Download a Snapshot

To download a Snapshot, follow these steps:

1. On the Snapshots page, select > Prepare Download. A new task named Prepare Download is created.
2. Once the task is completed, click to download the Snapshot.

Upload a Snapshot

To upload a Snapshot, follow these steps:

1. On the Snapshots page, click Upload Snapshot.
2. Select a Snapshot from your computer. When the file starts uploading, you will see a dialog window with a progress bar.
3. Once the file has been uploaded, a task named Upload Snapshot is created. After the task is completed, the Snapshot is successfully uploaded.

You can view, create, delete, and restore Snapshots using the Cognigy.AI API as well as download and upload them.

You can create Snapshots using the Cognigy CLI.

Deploy a Snapshot

To deploy a Snapshot, select it from the Snapshot list in the Endpoint settings. While an Endpoint is active, you can replace a Snapshot or remove it in the Endpoint settings. Active sessions continue to use the old Snapshot until they time out or you delete the old Snapshot. If you replace a Snapshot and delete it, the session is reset using the new Snapshot. If you use the Persistent History for Webchat, the user’s browser retains the chat history. Even after the session expires, users still see old messages, but any new message starts a new session.

Restore a Snapshot

You can use Snapshots to back up AI Agents versions. With this approach, you can restore a back up version if the new AI Agent doesn’t perform as intended. Before restoring a Snapshot, be aware of the following:

• Restoring a Snapshot overwrites all the current AI Agent’s resources. All the AI Agent’s resources are deleted before they’re recreated from the Snapshot you restore. In case you have active Endpoints pointing to the Flows of the AI Agent, the conversations stop working because the Flows are deleted.
• Restoring a Snapshot might require manual changes to the Endpoints. Restoring a Snapshot automatically updates only the Endpoints that are assigned to the primary Locale. You need to update Endpoints assigned to non-primary Locales manually. These Endpoints are marked with a red dot next to the Endpoint name after you restore the Snapshot, meaning that the settings are not complete.

Deploy AI Agents to Production with Snapshots

The following three scenarios show the recommended methods for deploying AI Agents into production.

Develop an AI Agent with a Single Project

With Snapshots, you can make your AI Agents available through Endpoints while you work on the next version of your AI Agent:

1. Develop and test Flows, Lexicons, Intents, and all other resources as usual. Eventually, you reach an AI Agent version that you want to publish to the users.
2. Create a Snapshot of the AI Agent. You don’t have to prepare a downloadable Package for the Snapshot because everything remains in the current Project.
3. To release the AI Agent version of the Snapshot, go to the Endpoint settings, for example, in the Webchat Endpoint settings, and select the new Snapshot and the Flow.

Your production environment now uses the AI Agent from the Snapshot.

Since you are using resources from the Snapshot in production, developers can change the Flows in the AI Agent without breaking the current conversations with your customers.

Develop an AI Agent with Multiple Projects

You want to build an AI Agent for FAQs on your website. In this case, you have two Projects:

• FAQ Bot development — a Project for developers to build and test the AI Agent.
• FAQ Bot production — a Project for the production environment.

1. Developers only have access to the FAQ Bot development Project, in which they can develop and test AI Agents. Eventually, they reach an AI Agent version that you want to publish to the users.
2. Create a Snapshot of the AI Agent in the FAQ Bot development Project and download it.
3. To release the AI Agent version of the Snapshot, upload the Snapshot to the FAQ Bot production Project. Then, select the uploaded Snapshot in the Endpoints settings of your production Endpoint.

Develop an AI Agent with a CI/CD Environments

You have the following environments:

• Dev — an environment for development purposes.
• Staging — an environment for staging purposes, where acceptance tests are conducted for newer versions.
• Production — an environment for publishing AI Agents to users.

1. Developers only have access to Projects in the Dev installation, in which they build AI Agents, design new experiences, or improve already existing solutions. Eventually, they reach an AI Agent version that you want to publish to the users.
2. Create Snapshots of the AI Agents in the Dev installation, download the Snapshots, and provide them to the teams working on the Staging installation.
3. People working on the Staging installation receive the Snapshots and upload them to their Projects. They select the uploaded Snapshots in their Endpoint settings and run acceptance tests.
4. If they find errors, they inform their development teams, who fix the problems and provide new Snapshots. If tests are successful, the Snapshots are moved to the Production installation.
5. To release the AI Agent version of the Snapshots, upload them to the Production installation and select the uploaded Snapshots in the production Endpoints.

More Information

• Endpoints
• Flows

Last modified on July 7, 2026