CapturesResource: Manage Recordings, Screenshots, and Cookies

list

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(input: { runId?: string } = {}, options?: RequestOptions)
Returns: { captures: Capture[] }

Each Capture has the following shape:

interface Capture {
  name: string;
  url: string;
  size: number;
  modified: number;
  type: "recording" | "screenshot";
}

list-captures.ts

const { captures } = await figranium.captures.list({ runId: "run_abc123" });

for (const capture of captures) {
  console.log(`${capture.type}: ${capture.name} (${capture.size} bytes)`);
}

screenshots

Returns only screenshot captures, omitting recordings.

HTTP endpoint: GET /api/data/screenshots
Signature: captures.screenshots(options?: RequestOptions)
Returns: { screenshots: Capture[] }

list-screenshots.ts

const { screenshots } = await figranium.captures.screenshots();

for (const shot of screenshots) {
  console.log(`${shot.name}: ${shot.url}`);
}

delete

Delete a single capture by its name.

HTTP endpoint: DELETE /api/data/captures/:name
Signature: captures.delete(name: string, options?: RequestOptions)
Returns: { success: boolean }

delete-capture.ts

const { success } = await figranium.captures.delete("run_abc123_recording.webm");

List stored browser cookies and their origins.

HTTP endpoint: GET /api/data/cookies
Signature: captures.cookies(options?: RequestOptions)
Returns: { cookies: UnknownRecord[]; origins: UnknownRecord[] }

list-cookies.ts

const { cookies, origins } = await figranium.captures.cookies();

console.log(`Found ${cookies.length} cookies across ${origins.length} origins`);

deleteCookie

Remove a specific cookie by name, optionally scoped to a domain and path.

HTTP endpoint: POST /api/data/cookies/delete
Signature: captures.deleteCookie(cookie: { name: string; domain?: string; path?: string }, options?: RequestOptions)
Returns: { success: boolean }

delete-cookie.ts

const { success } = await figranium.captures.deleteCookie({
  name: "session_id",
  domain: "example.com",
  path: "/",
});

clear

Delete all screenshots at once.

HTTP endpoint: POST /api/data/clear-screenshots
Signature: captures.clear(options?: RequestOptions)
Returns: { success: boolean }

clear-screenshots.ts

const { success } = await figranium.captures.clear();

clearCookies

Delete all stored cookies.

HTTP endpoint: POST /api/data/clear-cookies
Signature: captures.clearCookies(options?: RequestOptions)
Returns: { success: boolean }

clear-cookies.ts

const { success } = await figranium.captures.clearCookies();

Request options

Pass signal, timeoutMs, and custom headers.

Errors

Handle FigraniumError responses.

Executions

Start runs that produce captures.

Intro

Installation

Basics

Features

Agent Logic

API

JavaScript SDK

Integrations

Ops

Changelog

CapturesResource: Manage Recordings, Screenshots, and Cookies

Methods

Working example: list captures for a run and delete cookies

Request options

Errors

Executions

​Methods

​Working example: list captures for a run and delete cookies

​Related resources

Request options

Errors

Executions

Methods

Working example: list captures for a run and delete cookies

Related resources