> ## Documentation Index
> Fetch the complete documentation index at: https://docs.duvo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List Clarity Step Frames

> Return one representative screenshare frame for each current-process step. Explicit frame evidence wins. Otherwise, a timestamped screenshare transcript source selects the closest persisted frame at or after that timestamp, with the closest earlier frame as fallback. Pass `window` (1-5) to also receive that many neighbouring frames on each side as candidates, for recovering when the selected frame does not show the step. Pass `size=thumb` for 768px copies that are cheaper to download and inspect. Signed URLs are short-lived and can be null when signing is unavailable.



## OpenAPI

````yaml https://api.duvo.ai/v2/documentation/mintlify.json get /v2/clarity-v2/processes/{process_id}/snapshots/current_process/{snapshot_id}/step-frames
openapi: 3.0.3
info:
  title: Duvo Public API
  description: >-
    Public API for programmatic access to Duvo. Authenticate with API keys
    created in the Duvo dashboard.


    ## Rate limits


    Requests are counted per API key. Every response advertises the quota with
    the IETF RateLimit fields, so a client can self-throttle without waiting for
    a rejection:


    - `RateLimit-Policy: "default";q=<quota>;w=<window seconds>` — the policy in
    force: `q` requests per `w` seconds.

    - `RateLimit: "default";r=<remaining>;t=<seconds>` — the live state: `r`
    requests left, quota resetting in `t` seconds.

    - Read the quota from the headers rather than hard-coding it; it differs per
    environment.

    - The same numbers are also sent as `ratelimit-limit`, `ratelimit-remaining`
    and `ratelimit-reset`.


    Once the quota is exhausted the API answers `429 Too Many Requests` with
    `Retry-After` set to the seconds to wait; honor it instead of retrying
    immediately.
  version: 1.0.0
servers:
  - url: https://api.duvo.ai
    description: Production server
security: []
tags:
  - name: Runs
    description: Start, monitor, and manage agent runs (Runs in the Duvo UI)
  - name: Sandboxes
    description: Create sandboxes and upload files for agent runs
  - name: Queues
    description: Manage queues and their agent bindings
  - name: Cases
    description: Create, list, and manage cases and their labels within queues
  - name: Case Approvals
    description: Submit decisions on pending case approval requests issued by an agent run
  - name: Case Attachments
    description: Upload, list, download, and remove the files attached to a case
  - name: Automations
    description: >-
      List and manage automations — the workspace container that groups the
      agents and queues making up one end-to-end process
  - name: Agents
    description: Create and manage agents for automation workloads
  - name: Revisions
    description: Create and manage agent revisions — the underlying Setup for an Agent
  - name: Agent Folders
    description: Organize agents into folders
  - name: Agent Memory
    description: Read an agent's memory files (the Memory feature in the Duvo UI)
  - name: Suggestions
    description: >-
      List, apply, and dismiss an Agent's improvement suggestions (the
      suggestions inbox in the Duvo UI)
  - name: Notifications
    description: >-
      List, read, dismiss, and clear the authenticated user's team notifications
      (the Notification Center in the Duvo UI)
  - name: Schedules
    description: List schedules configured for an agent
  - name: Duvo Pulse
    description: >-
      Create, list, iterate on, and delete Duvo Pulse dashboards — live,
      agent-generated visualizations of your Duvo data
  - name: Case Triggers
    description: >-
      Configure case triggers that automatically dispatch agent runs (Runs in
      the Duvo UI) for cases added to a queue
  - name: Triggers
    description: >-
      Configure event triggers that start a Run automatically when an external
      event fires (e.g. an email arrives, a Linear issue is created, or a file
      changes in Google Drive)
  - name: Skills
    description: Manage team and system skills (reusable knowledge packs).
  - name: Files
    description: Manage team files.
  - name: Plugins
    description: Discover plugins that can be referenced from a revision.
  - name: Organizations
    description: Inspect organizations you belong to and the teams within them
  - name: Team
    description: Inspect the team and members associated with the API key
  - name: Invites
    description: >-
      Invite people to a team — one at a time or in bulk, scoped to a Clarity
      process or the whole team — and manage the team's shareable invite link
  - name: Integrations
    description: Browse the team's catalog of available integration types
  - name: Connections
    description: Manage your connected integrations
  - name: Credentials
    description: >-
      Manage logins (domain + username + password + TOTP) used by agents to sign
      in to websites and desktop applications, and attach them to assignment
      revisions
  - name: Secrets
    description: >-
      Manage env-var secrets injected into runs, and attach them to assignment
      revisions. Only metadata is exposed; values are never returned
  - name: Revision Integrations
    description: >-
      Attach integrations to assignment revisions, pin specific connections, and
      link queues
  - name: ClarityV2
    description: >-
      Manage Clarity v2 process snapshots, automation proposals, and the
      extra-capture-request follow-up loop
paths:
  /v2/clarity-v2/processes/{process_id}/snapshots/current_process/{snapshot_id}/step-frames:
    get:
      tags:
        - ClarityV2
      summary: List Clarity Step Frames
      description: >-
        Return one representative screenshare frame for each current-process
        step. Explicit frame evidence wins. Otherwise, a timestamped screenshare
        transcript source selects the closest persisted frame at or after that
        timestamp, with the closest earlier frame as fallback. Pass `window`
        (1-5) to also receive that many neighbouring frames on each side as
        candidates, for recovering when the selected frame does not show the
        step. Pass `size=thumb` for 768px copies that are cheaper to download
        and inspect. Signed URLs are short-lived and can be null when signing is
        unavailable.
      operationId: listClarityStepFrames
      parameters:
        - schema:
            type: string
          in: query
          name: step_ids
          required: false
          description: >-
            Optional comma-separated step ids to resolve, for example
            `task-a,task-b` (maximum 100). Omit to resolve every step.
        - schema:
            default: 0
            type: integer
            minimum: 0
            maximum: 5
          in: query
          name: window
          required: false
          description: >-
            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.
        - schema:
            default: full
            type: string
            enum:
              - full
              - thumb
          in: query
          name: size
          required: false
          description: >-
            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.
        - schema:
            type: string
            format: uuid
          in: path
          name: process_id
          required: true
          description: The clarity process id
        - schema:
            type: string
            format: uuid
          in: path
          name: snapshot_id
          required: true
          description: The current-process snapshot id
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  steps:
                    type: array
                    items:
                      type: object
                      properties:
                        step_id:
                          type: string
                          minLength: 1
                        frame:
                          nullable: true
                          type: object
                          properties:
                            capture_id:
                              type: string
                              format: uuid
                            timestamp_ms:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            selection:
                              type: string
                              enum:
                                - step_source
                                - nearest_transcript_source
                              description: >-
                                step_source: explicit screenshare_frame evidence
                                on the step. nearest_transcript_source: closest
                                persisted frame to a screenshare transcript
                                timestamp; review before publishing.
                            signed_url:
                              nullable: true
                              description: >-
                                Short-lived download URL for the frame; null
                                when signing is unavailable. Download promptly
                                rather than storing the URL.
                              type: string
                              format: uri
                            candidates:
                              type: array
                              items:
                                type: object
                                properties:
                                  timestamp_ms:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  offset:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                    description: >-
                                      Position relative to the selected frame in
                                      the capture's persisted frame sequence: -1
                                      is the frame just before it, 1 the frame
                                      just after.
                                  signed_url:
                                    nullable: true
                                    description: >-
                                      Short-lived download URL for the frame;
                                      null when signing is unavailable. Download
                                      promptly rather than storing the URL.
                                    type: string
                                    format: uri
                                required:
                                  - timestamp_ms
                                  - offset
                                  - signed_url
                                additionalProperties: false
                              description: >-
                                Neighbouring frames from the same capture,
                                ordered by offset. Empty unless the `window`
                                query parameter is greater than 0.
                          required:
                            - capture_id
                            - timestamp_ms
                            - selection
                            - signed_url
                            - candidates
                          additionalProperties: false
                      required:
                        - step_id
                        - frame
                      additionalProperties: false
                required:
                  - steps
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                additionalProperties: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Get your API key from the Duvo dashboard.

````