Skip to main content
GET
List Clarity Step Frames

Authorizations

Authorization
string
header
required

API key authentication. Get your API key from the Duvo dashboard.

Path Parameters

process_id
string<uuid>
required

The clarity process id

snapshot_id
string<uuid>
required

The current-process snapshot id

Query Parameters

step_ids
string

Optional comma-separated step ids to resolve, for example task-a,task-b (maximum 100). Omit to resolve every step.

window
integer
default:0

Number of neighbouring persisted frames to return on each side of the selected frame as candidates (0-5, default 0). Use to recover when the selected frame does not show the step.

Required range: 0 <= x <= 5
size
enum<string>
default:full

full: the persisted screenshot (1920px wide). thumb: a 768px-wide copy, cheaper to download and to inspect visually; use it to check whether a frame shows the step, then fetch full for the document.

Available options:
full,
thumb

Response

Default Response

steps
object[]
required