Apps

Export an App and its child entities as a portable bundle (v2)

Returns a versioned bundle (schemaVersion: ethora.app.bundle.v1) containing the App doc (secrets stripped) and selected child entities.

Use cases:

  • Backup: customers can snapshot an app and its assets as JSON.
  • Migration: move an app between environments by exporting from the source and re-importing at the destination.

Authorization: only the app's owner or a super-admin can export.

Format: json returns the bundle directly (Content-Type: application/json with download disposition). zip returns a zip archive containing bundle.json.

Default include set is chats,sources,botInstances (structural data without PII). Users are opt-in via include=users because they carry email addresses and other personal data.

get/v2/apps/{appId}/export

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/apps/{appId}/export
  • Auth: HTTP bearer

Path parameters

appIdstring required

Target App ID. Must be an app the calling actor owns or has been delegated access to.

Query parameters

format'json' | 'zip'

Bundle format: json (default) or zip (same content, zipped for transport).

includestring

CSV of categories: chats,users,sources,botInstances. Pass all for everything. Default excludes users for PII safety.

Response

bundle

Changes

No recorded changes to this operation across all 1 revision of this API.