---
canonical_url: "https://docs.composio.dev/toolkits/tinyfish"
markdown_url: "https://docs.composio.dev/toolkits/tinyfish.md"
product: "platform"
version: null
last_updated: null
---

# TinyFish

TinyFish provides web automation, live search, content extraction, research, browser sessions, reusable browser profiles, and run management through native REST APIs.

- **Category:** web scraping & browser
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 23
- **Triggers:** 0
- **Slug:** `TINYFISH`
- **Version:** 20261014_01
- **Instant:** Supported on the latest version. Support varies by tool.

## Tools

### Cancel Profile Setup Session

**Slug:** `TINYFISH_CANCEL_PROFILE_SETUP_SESSION`

Cancel a Browser Context Profile setup session and permanently discard its unsaved cookies and browser storage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | Yes | Browser Context Profile whose temporary setup session should be cancelled. |
| `session_id` | string | Yes | Setup session to cancel and discard without saving its browser state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Runs

**Slug:** `TINYFISH_CANCEL_RUNS`

Idempotently cancel one or up to 100 asynchronous or SSE runs. Active cancellation is irreversible; synchronous runs cannot be cancelled, and already-terminal runs are returned with their actual status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_ids` | array | Yes | One to 100 TinyFish run IDs to cancel. Only asynchronous and SSE runs can be cancelled; synchronous runs cannot be cancelled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Browser Session

**Slug:** `TINYFISH_CREATE_BROWSER_SESSION`

Create an isolated TinyFish remote browser session and return its CDP connection URL. This action starts billable browser infrastructure: TinyFish meters Browser usage until the session ends or becomes inactive. You must call Terminate Browser Session with the returned session_id immediately after browser work finishes, including after failures, to stop further usage charges. Creation can return before startup navigation completes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Optional startup URL. TinyFish adds https:// when given a bare domain; session creation may finish before navigation to this URL completes. |
| `timeout_seconds` | integer | No | Requested session lifetime in seconds (5-86400). The effective lifetime may be capped by the TinyFish account plan. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Profile

**Slug:** `TINYFISH_CREATE_PROFILE`

Create a reusable Browser Context Profile for cookies and browser storage; this changes persistent account state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable name for the Browser Context Profile (1-100 characters). |
| `set_as_default` | boolean | No | Whether the new profile should become the account's default profile. |
| `proxy_country_code` | string ("US" | "GB" | "CA" | "AU" | "DE" | "FR" | "IT" | "ES" | "NL" | "JP" | "SG" | "BR" | "IN") | No | Country for the profile proxy, or null for no country preference. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Profile

**Slug:** `TINYFISH_DELETE_PROFILE`

Permanently delete a Browser Context Profile and all browser state saved in it. This action cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | Yes | Browser Context Profile ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Profile Domain

**Slug:** `TINYFISH_DELETE_PROFILE_DOMAIN`

Permanently remove saved cookies and browser storage for one domain from a Browser Context Profile. This action cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Exact domain whose saved cookies and browser storage should be removed. |
| `profile_id` | string | Yes | Browser Context Profile containing the saved domain state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch URLs

**Slug:** `TINYFISH_FETCH_URLS`

Render and extract content from 1-10 URLs in one provider-native batch. Always inspect both results and errors because HTTP 200 can contain successful pages and per-URL failures together.

**Instant:** Supported on the latest version.

**Instant pricing:** $0 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ttl` | integer | No | Cache freshness tolerance in seconds; 0 prefers a live fetch. |
| `urls` | array | Yes | Between 1 and 10 public HTTP(S) URLs to fetch in parallel. |
| `links` | boolean | No | Whether to include absolute outbound page links. |
| `format` | string ("markdown" | "html" | "json") | No | Output representation for extracted page content. |
| `purpose` | string | No | Nonblank reason for fetching the pages, used to guide extraction. |
| `image_links` | boolean | No | Whether to include absolute image links. |
| `if_none_match` | string | No | ETag validator from a prior fetch; valid only with exactly one URL. |
| `page_metadata` | boolean | No | Whether to include browser and page-head metadata. |
| `exclude_selectors` | array | No | One to 20 nonblank CSS selectors (each at most 1000 characters) to remove. |
| `if_modified_since` | string | No | Last-Modified validator from a prior fetch; valid only with exactly one URL. |
| `include_selectors` | array | No | One to 20 nonblank CSS selectors (each at most 1000 characters) to include. |
| `per_url_timeout_ms` | integer | No | Independent wall-clock timeout for each URL in milliseconds (1-110000). |
| `include_etag_and_last_modified` | boolean | No | Whether to return origin ETag and Last-Modified validators when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Profile

**Slug:** `TINYFISH_GET_PROFILE`

Get one Browser Context Profile and its saved-domain metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | Yes | Browser Context Profile ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Runs

**Slug:** `TINYFISH_GET_RUNS`

Get summary records for 1-100 TinyFish automation run IDs in one request. The response separately reports IDs that were not found or are not owned.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `run_ids` | array | Yes | TinyFish automation run IDs to retrieve in one batch (1-100 IDs). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Wallet

**Slug:** `TINYFISH_GET_WALLET`

Get the TinyFish wallet balance, auto-reload and pending-top-up state, and current Agent and Browser rates. Monetary values are returned as exact decimal strings. Legacy-credit accounts report FEATURE_NOT_AVAILABLE rather than an authentication failure.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Profiles

**Slug:** `TINYFISH_LIST_PROFILES`

List Browser Context Profiles available to the connected TinyFish account. Use the returned IDs when attaching or managing reusable browser state.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Research Runs

**Slug:** `TINYFISH_LIST_RESEARCH_RUNS`

List saved TinyFish research runs with optional status, query, date, and sort filters, returning one cursor-controlled page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum saved runs to return (1-100). |
| `query` | string | No | Filter saved research runs by query text. |
| `cursor` | string | No | Opaque cursor returned by this tool. Omit it for the first page. |
| `status` | string ("RUNNING" | "COMPLETED" | "FAILED" | "CANCELLED" | "TIMED_OUT" | "QUEUED") | No | Filter by a TinyFish research-run lifecycle status. |
| `created_after` | string | No | Return runs created after this ISO 8601 timestamp. |
| `created_before` | string | No | Return runs created before this ISO 8601 timestamp. |
| `sort_direction` | string ("asc" | "desc") | No | Sort by creation time in ascending or descending order. Continuation cursors retain the first page's value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Runs

**Slug:** `TINYFISH_LIST_RUNS`

List automation runs with optional status, goal, date, and sort filters, returning one cursor-controlled page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `goal` | string | No | Filter runs by a case-insensitive partial match on goal text. |
| `limit` | integer | No | Maximum runs to return in this page (1-100). |
| `cursor` | string | No | Opaque cursor returned by this tool. Omit it for the first page. |
| `status` | string ("PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "CANCELLED") | No | Return only runs in this lifecycle state. |
| `created_after` | string | No | Return runs created after this ISO 8601 timestamp. |
| `created_before` | string | No | Return runs created before this ISO 8601 timestamp. |
| `sort_direction` | string ("asc" | "desc") | No | Sort by creation time in ascending or descending order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Usage

**Slug:** `TINYFISH_LIST_USAGE`

List one page of Search, Fetch, or Browser usage history. Search and Fetch usage reads are free; Browser usage requires the paid Browser service.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | One-based usage-history page. |
| `limit` | integer | No | Maximum usage records to return in this page (1-1000). |
| `status` | string ("completed" | "failed" | "running" | "ended") | No | Filter by completed or failed for Search and Fetch, or running or ended for Browser. |
| `service` | string ("search" | "fetch" | "browser") | Yes | TinyFish product whose usage history should be listed. |
| `end_before` | string | No | Return usage created before this ISO 8601 timestamp. |
| `session_id` | string | No | Browser session ID filter; valid only when service is browser. |
| `start_after` | string | No | Return usage created after this ISO 8601 timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Vault Connections

**Slug:** `TINYFISH_LIST_VAULT_CONNECTIONS`

List display-safe metadata for password-manager vaults connected to TinyFish. Credentials and secret values are excluded.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Vault Items

**Slug:** `TINYFISH_LIST_VAULT_ITEMS`

List display-safe metadata for items synchronized from password-manager vaults connected to TinyFish. Secret field values are never returned.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save Profile Setup Session

**Slug:** `TINYFISH_SAVE_PROFILE_SETUP_SESSION`

Persist cookies and browser storage from a completed setup session into a Browser Context Profile, then clean up the temporary session. Persisted state and successful session cleanup cannot be undone. The response retains domain-level skips and failures plus cleanup status so partial success remains visible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | Yes | Profile that should receive the setup session's browser state. |
| `session_id` | string | Yes | Completed setup session whose cookies and browser storage should be persisted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Web

**Slug:** `TINYFISH_SEARCH_WEB`

Search live web pages, news, or research papers with domain and time filters, optionally fetching result pages inline, and return exactly one caller-selected zero-based result page.

**Instant:** Supported on the latest version.

**Instant pricing:** $0 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Zero-based result page (0-10). |
| `query` | string | Yes | Search query (1-2000 characters). |
| `purpose` | string | No | Why the results are needed, used by TinyFish to improve ranking. |
| `language` | string | No | Language code for results. TinyFish infers it from location, or defaults to en when both fields are omitted. |
| `location` | string | No | Country code for localized results. TinyFish infers it from language, or defaults to US when both fields are omitted. |
| `after_date` | string | No | Earliest publication date, inclusive (YYYY-MM-DD). Not compatible with recency_minutes or research_paper searches. |
| `before_date` | string | No | Latest publication date, inclusive (YYYY-MM-DD). Not compatible with recency_minutes or research_paper searches. |
| `domain_type` | string ("web" | "news" | "research_paper") | No | Content corpus to search: web, news, or research_paper. |
| `fetch_content` | boolean | No | Fetch each result page inline with TinyFish's default Fetch settings. Fetched content or per-result fetch errors are returned on each result. |
| `exclude_domains` | array | No | Exclude results from these domains; sent as one comma-separated value. |
| `include_domains` | array | No | Only return results from these domains; sent as one comma-separated value. |
| `recency_minutes` | integer | No | Only return content from the last 1-5256000 minutes. Not compatible with date bounds or research_paper searches. |
| `include_thumbnail` | boolean | No | Request thumbnail URLs when available; sent as true or false. |
| `publication_year_max` | integer | No | Maximum publication year, inclusive (0-9999). Valid only for research_paper searches. |
| `publication_year_min` | integer | No | Minimum publication year, inclusive (0-9999). Valid only for research_paper searches. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Profile Setup Session

**Slug:** `TINYFISH_START_PROFILE_SETUP_SESSION`

Start a billable temporary remote browser session for establishing login state in a Browser Context Profile. The returned browser state is not saved automatically: after setup, always call Save Profile Setup Session to persist it or Cancel Profile Setup Session to discard it and tear down the session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Optional absolute HTTP(S) URL or bare domain to open when the temporary setup browser starts. TinyFish prefixes bare domains with https://. |
| `profile_id` | string | Yes | Browser Context Profile that will receive saved login and browser state. |
| `timeout_seconds` | integer | No | Requested lifetime of the billable temporary browser session in seconds (5-86400), subject to the account plan's cap. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sync Vault Items

**Slug:** `TINYFISH_SYNC_VAULT_ITEMS`

Refresh display-safe item metadata from all password-manager vaults already connected to TinyFish. Synchronization can add, update, or remove mirrored items. Returns synchronization counts and allowlisted item metadata without credential or secret values.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Terminate Browser Session

**Slug:** `TINYFISH_TERMINATE_BROWSER_SESSION`

Idempotently terminate a remote TinyFish browser session to stop further browser usage charges. Already-ended sessions are also successful.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Browser session to terminate; use only a session the caller owns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Profile

**Slug:** `TINYFISH_UPDATE_PROFILE`

Rename a Browser Context Profile or change its default and proxy-country settings. Omitted fields remain unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New profile name (1-100 characters); omit to leave it unchanged. |
| `profile_id` | string | Yes | Browser Context Profile ID to update. |
| `set_as_default` | boolean | No | Whether this profile should be the account default; omit to leave it unchanged. |
| `proxy_country_code` | string ("US" | "GB" | "CA" | "AU" | "DE" | "FR" | "IT" | "ES" | "NL" | "JP" | "SG" | "BR" | "IN") | No | New proxy country; pass null explicitly to clear the setting, or omit the field to leave it unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Profile State

**Slug:** `TINYFISH_UPLOAD_PROFILE_STATE`

Upload cookies and local or session storage directly into a Browser Context Profile. This changes persistent login state and may transmit authentication secrets; call it only with the credential owner's explicit authorization. TinyFish provides no rollback endpoint, so restoring prior state requires a caller-held copy or deleting the affected domains.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cookies` | array | Yes | Up to 3000 browser cookies. WARNING: cookies can grant account access; provide them only with the credential owner's explicit authorization. |
| `profile_id` | string | Yes | Browser Context Profile ID that should receive the uploaded state. |
| `local_storage` | array | No | Up to 100 local-storage origin records. WARNING: values may contain authentication tokens or private user data. |
| `session_storage` | array | No | Up to 100 session-storage origin records. WARNING: values may contain authentication tokens or private user data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |