captures resource on the Figranium Kotlin SDK gives you access to recordings, screenshots, and browser cookies produced during task executions. You can list captures for a specific run, delete individual files, inspect stored cookies, and bulk-clear screenshots or cookies when you need to reclaim space or reset state.
main.kt
Methods
list
list
Returns all captures, including recordings and screenshots. Optionally filter by Each capture entry contains
runId.- HTTP endpoint:
GET /api/data/captures(withrunIdquery parameter when set) - Signature:
captures.list(runId: String? = null, options: RequestOptions = RequestOptions()): List<Capture>
list_captures.kt
name, url, size, modified, and type ("recording" or "screenshot").screenshots
screenshots
Returns only screenshot captures, omitting recordings.
- HTTP endpoint:
GET /api/data/screenshots - Signature:
captures.screenshots(options: RequestOptions = RequestOptions()): List<Capture>
list_screenshots.kt
delete
delete
Delete a single capture by its name.
- HTTP endpoint:
DELETE /api/data/captures/{name} - Signature:
captures.delete(name: String, options: RequestOptions = RequestOptions()): JsonObject
delete_capture.kt
clear
clear
Delete all screenshots at once.
- HTTP endpoint:
POST /api/data/clear-screenshots - Signature:
captures.clear(options: RequestOptions = RequestOptions()): JsonObject
clear_screenshots.kt
Working example: list captures for a run and delete cookies
This example combineslist and deleteCookie to clean up after a run: it lists captures for a specific run, then removes a session cookie for the target domain.
cleanup_after_run.kt
Model
Capture
Related resources
Request options
Pass custom headers and per-request timeouts.
Errors
Handle FigraniumException responses.
Executions
Start runs that produce captures.
Captures and storage
Learn how Figranium stores recordings and screenshots.
Session state
Understand how cookies and session state work in Figranium.