Skip to main content
The captures resource on the Figranium Swift 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.swift

Methods

Returns all captures, including recordings and screenshots. Optionally filter by runID.
  • HTTP endpoint: GET /api/data/captures (with runId query parameter when set)
  • Signature: captures.list(runID: String? = nil, options: RequestOptions = .init()) async throws -> [Capture]
list_captures.swift
Each capture entry contains name, url, size, modified, and type ("recording" or "screenshot").
Returns only screenshot captures, omitting recordings.
  • HTTP endpoint: GET /api/data/screenshots
  • Signature: captures.screenshots(options: RequestOptions = .init()) async throws -> [Capture]
list_screenshots.swift
Delete a single capture by its name.
  • HTTP endpoint: DELETE /api/data/captures/{name}
  • Signature: captures.delete(_ name: String, options: RequestOptions = .init()) async throws -> JSONObject
delete_capture.swift
List stored browser cookies and their origins.
  • HTTP endpoint: GET /api/data/cookies
  • Signature: captures.cookies(options: RequestOptions = .init()) async throws -> JSONObject
list_cookies.swift
Remove a specific cookie by name, optionally scoped to a domain and path.
  • HTTP endpoint: POST /api/data/cookies/delete
  • Signature: captures.deleteCookie(name: String, domain: String? = nil, path: String? = nil, options: RequestOptions = .init()) async throws -> JSONObject
delete_cookie.swift
Delete all screenshots at once.
  • HTTP endpoint: POST /api/data/clear-screenshots
  • Signature: captures.clear(options: RequestOptions = .init()) async throws -> JSONObject
clear_screenshots.swift
Delete all stored cookies.
  • HTTP endpoint: POST /api/data/clear-cookies
  • Signature: captures.clearCookies(options: RequestOptions = .init()) async throws -> JSONObject
clear_cookies.swift

Working example: list captures for a run and delete cookies

This example combines list 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.swift

Model

Capture

Request options

Pass custom headers and per-request timeouts.

Errors

Handle FigraniumError 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.