Reference
URL parameters
Every workspace setting can be pre-loaded from the URL — handy for sharing a ready-to-go labeling session or embedding it elsewhere. Presets are read onceon load (they don't sync back into the URL). Booleans accept 1/true/yes/on, enums are case-insensitive, and anything invalid is silently ignored.
| Parameter | Values | Description |
|---|---|---|
| apiKey | ei_… | Edge Impulse API key. Used to open a session, then stripped from the address bar. |
| project/ eiProject | int ≥ 1 | Project ID to connect to. Not required when apiKey is provided (API keys are scoped to a single project). |
| category | training | testing | anomaly | Which dataset split to load. |
| labels | comma list | Filter the sample queue to these labels, e.g. labels=dog,cat. |
| task | classify | detect | audio | timeseries | sam | transcribe | Force a labeling template instead of auto-detecting per sample. |
| mode | relabel | import | Relabel existing samples, or import-and-label new data. |
| autoAdvance | bool | Jump to the next unlabeled sample after each submit. Default: false. |
| autoAnnotate | bool | Turn on Auto-Annotation (interactive SAM) so smart-tool clicks request a mask + box. Use with task=sam. Default: true. |
| autoAccept | bool | Auto-accept SAM suggestions instead of confirming each one. Use with autoAnnotate. Default: true. |
| limit | int 1–1000 | How many samples to pull into the queue. |
| offset | int ≥ 0 | Pagination offset into the dataset. |
| theme | dark | light | unicorn | Force the colour scheme. |
| embed | bool | Hide chrome for embedding the workspace in an iframe. |
| studioHost | host | Override the Studio API base (self-hosted / staging EI). |
| ingestionHost | host | Override the Ingestion API base. |
Example
https://label.jennyspeelman.dev/?apiKey=ei_abc123&category=training&task=audio&autoAdvance=1Connects using the API key (which is scoped to a single project), loads the training set with the audio-classification template and auto-advance on. The key is stored in a secure http-only cookie and removed from the URL on load.