List frames
list_framesList frame paths from a capture series, ordered by index; collect rendered PNGs from a run.
Instructions
List the frames of a capture_frame series, ordered by index.
When to use: gathering a whole run's PNGs at the end without re-deriving paths. To produce
frames use capture_frame.
Key params: series is sanitized identically to capture_frame (defaults to run).
Return shape: FrameListResult — doc_id, series, and frames (each a FrameInfo with
frame_index + a resolvable workspace_relative_path), ordered by index; empty when the series
has no frames yet.
Example: list_frames(doc_id, series="cleanup")
Risk class: low (read-only listing of the managed artifacts dir).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doc_id | Yes | ||
| series | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doc_id | Yes | ||
| frames | Yes | ||
| series | Yes |