Help & reference

Documentation

Guides for using Zegami day-to-day, plus reference material for administrators and integrators.

Pick a topic to get started. Each guide walks through a single workflow end-to-end, with screenshots of the actual UI you’ll see in the app.

Getting started with Zegami

Sign in, create a workspace, and build your first collection in a few minutes.

Collection settings

A tour of the eight settings tabs: General, Tags, Sharing, Hero, Data, Processing, Actions, and Versions.

Uploading and importing collections

Create a collection from your own images and metadata, or mirror an external catalogue like IIIF, the Met, or DICOMweb.

Managing image content via the Data tab

Add, replace, rotate, and remove individual images in an existing collection without touching the source data.

Processing and analysis

What the pipeline builds, and the optional analysis steps — Parquet, KTX2, CLIP, UMAP, TDA, features — you can toggle per collection.

Sharing and publishing collections

Control who can see a collection, give it a friendly URL, and feature it publicly.

Viewing collections

Navigate the viewer, switch between Grid, Table, Scatter, Graph, and Map views, and inspect individual images.

Filtering, search, and similarity

Narrow a collection with column filters, full-text search, and visual / semantic similarity.

Annotating images

Draw bounding boxes, polygons, and points; assign classes; tag images; and import / export W3C annotations.

Radiology and medical imaging

Slice navigation, window/level, and segmentation overlays for volumetric CT / MR collections.

Exporting data and images

Export metadata, images, a PDF, or W3C annotations — for the whole collection or just your current selection.

Roles and permissions

Who can see and do what — collection roles, workspace roles, organisation roles, and how visibility interacts with them.

Account settings and API keys

Manage your profile, telemetry consent, integrations, and API keys for programmatic access.

Workspaces and members

Organize collections into workspaces, invite members, set roles, and recover deleted collections from trash.

Organisations

Group workspaces under an organisation for centralized membership, roles, and billing.