Docs guide

Find the page you need: start here, read the role guides, or open a module section.

These docs follow the console. Each function page starts from the job you want to finish and shows the screen where you do it. Read the quickstart once to see the whole flow, then open the sections you work in.

Documentation map

Section	Who it is for	Reading time	What it covers
Get started	Everyone, the first time	Short	The quickstart, the console tour and the key concepts.
Role guides	Each team role	Short	What each role can do, its usual steps and where to go next.
Projects	Team members. Owners and Admins create projects.	Medium	The project list, the project overview, project settings and members.
Collection orders	Owners, Admins, Editors and data suppliers	Medium	Create a collection order, assign collectors, deliver and accept recordings.
Recordings	Owners, Admins, Editors and Uploaders	Medium	Upload recordings, supported formats, recording status and playback.
Workflows	Owners, Admins and Editors. Researchers for team algorithms (beta).	Long	Edit a workflow, read runs and rerun steps, and the algorithms that run in a workflow.
Episodes	Editors and Reviewers	Medium	Review episodes, label them, and check quality.
Dataset versions	Owners, Admins and Editors. Researchers with a project role.	Medium	Freeze episodes into a version, export it and search across versions.
Training	Owners, Admins and Editors. Researchers with a project role.	Long	Start a training job, follow it, and work with models and deployments.
My work	Labelers, Reviewers and data suppliers	Short	The annotation, review and repair tasks assigned to you.
Team settings	Owners and Admins	Medium	Team members, API keys, storage, audit log and webhooks.
Usage and billing	Owners, Admins and billing admins	Short	The usage of the current billing period and the storage used by each project.
FAQ	Everyone	Short	Answers to common problems with sign-in, upload, quality, export and permissions.
Developer reference	Developers	Long	The CLI, the REST API, the SDK, authentication and webhooks.

Reading path by role

Role	Reading path
Owners and Admins	Quickstart → Key concepts → Team settings → Project members → Usage and billing
Editors and Uploaders	Quickstart → Upload recordings → Workflows → Episodes → Dataset versions
Data suppliers	My work → Deliver recordings
Labelers and Reviewers	My work → Annotation
Researchers	Key concepts → Dataset versions → Training → Models

Next