Brand

API reference

Browse the Brand actions for working with kits, versioned snapshots, connections and assets. Each action guide includes its inputs, captured example responses, verification and recovery.

Discover actions

Inspect the active identity, application, permissions and workspace before preparing a request. Fixture identifiers are examples and grant no live access.

topolo whoami --json
topolo actions --service app_topolo_brand --limit 100 --detail --json

Action guides

• Get widget summary — widget.get. Read the Brand widget summary for the selected workspace.
• Get workspace bootstrap — workspace.bootstrap. Read the verified user and organization used to bootstrap Brand.
• Delete workspace — workspaces.delete. Archive an empty Brand workspace through the platform workspace authority.
• Export workspace privacy data — privacy.export. Export records and asset download paths belonging to the selected Brand workspace.
• Erase workspace privacy data — privacy.delete. Permanently erase Brand data and stored asset objects for the selected workspace.
• List brand kits — brand_kits.list. List Brand kits in the selected workspace.
• Get brand kit — brand_kits.get. Read one Brand kit and the presentation of its current published version.
• Create brand kit — brand_kits.create. Create an active Brand kit container in the selected workspace.
• Update brand kit — brand_kits.update. Update a Brand kit name or description.
• Delete brand kit — brand_kits.delete. Permanently delete a never-published, unbound Brand kit.
• Retire brand kit — brand_kits.retire. Retire a Brand kit so new resolution no longer selects it.
• List brand versions — brand_kit_versions.list. List draft, published and retired versions of a kit.
• Get brand version — brand_kit_versions.get. Read an exact Brand version and its rendering presentation.
• Create brand version — brand_kit_versions.create. Create a draft Brand version from a complete typed snapshot.
• Update draft brand version — brand_kit_versions.update. Update a draft snapshot or change note.
• Publish brand version — brand_kit_versions.publish. Publish a draft as the immutable version consumers resolve.
• Discard brand draft — brand_kit_versions.discard. Permanently discard an unpublished working draft.
• Restore brand version — brand_kit_versions.restore. Copy an earlier snapshot into the kit’s working draft.
• Request brand version review — brand_kit_versions.request_review. Record a review request for a draft version.
• List brand bindings — brand_bindings.list. List consumer bindings for kits in the selected workspace.
• Bind consumer resource — brand_bindings.upsert. Bind a consumer resource or shared scope to an active kit.
• Delete brand binding — brand_bindings.delete. Remove one consumer binding.
• Resolve brand kit — brand_kits.resolve. Resolve an active published kit by exact kit or exact consumer binding.
• Resolve brand for context — brand_kits.resolve_context. Resolve the first eligible brand for a consumer context.
• Validate branded content — brand_kits.validate. Validate content and snapshot governance against a supplied Brand snapshot.
• List brand assets — brand_assets.list. List registered asset records for a kit.
• Register brand asset — brand_assets.register. Register pending metadata for an asset before uploading its bytes.
• Upload brand asset content — brand_assets.upload. Upload or replace bytes for a registered Brand asset.
• Download brand asset content — brand_assets.download. Download authenticated content for a ready Brand asset.

Prepare and verify a call

Read the selected action and its guide, discover authorized identifiers, validate the exact input, and inspect its executable plan. Confirm a mutation, then perform the guide’s verification steps. A recorded review request or accepted operation is not proof of notification delivery.