td_capture_frame
Capture a single frame from a TOP node, returning resolution, format, and byte size. Optionally include a base64 image or save the frame to disk.
Instructions
Capture a single frame from a TOP node, metadata-first.
Returns resolution, format, and byte size; the base64 image comes back only when confirm=True or save_path is set (behind that gate, so token cost stays near-zero by default). If save_path is set the frame is written to disk TD-side and only metadata + the saved path come back — the cheap visual-verify loop. Ask the user before setting confirm=True because image payloads consume significant model context tokens. Prefer td_screenshot for a quick inline thumbnail; prefer td_capture_and_analyze when you also want cooking state and errors folded into the same call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Path to a TOP node to capture | |
| confirm | No | If True, include base64 image in response | |
| quality | No | JPEG quality 0.0-1.0 | |
| save_path | No | Optional disk destination. When set, TouchDesigner writes the frame to this path and the tool returns metadata + the saved path with NO base64 payload (overrides confirm). Accepts an absolute path under your home directory or a bare filename (saved under ~/.tdpilot/captures/). Extension must be .png/.jpg/.jpeg. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |