Tinyfish · Web Data

TinyFish Web Agent Automation API / Run browser automation synchronously

Execute a browser automation task synchronously and wait for completion. Returns the final result once the automation finishes (success or failure). Use this endpoint when you need the complete result in a single response. Note: Runs created via this endpoint cannot be cancelled. If you need cancellation support, use /v1/automation/run-async or /v1/automation/run-sse instead.

Private Gateway connection

Data below comes from the configured private Gateway. Provider activation remains governed by its evidence and policy gates.

unverifiedRequest shape unavailableUnverified

Published API evidence

Public metadata only. Response bodies, credentials, and internal review notes are never displayed.

No verification date is claimed. No response capture is claimed.

Request parameters

agent_config body · optional
Agent behavior configuration
api_integration body · optional
Name of the integration making this API call (e.g., "dify", "zapier", "n8n"). Used for analytics. Example: "dify"
browser_profile body · optional
Browser profile for execution. LITE uses standard browser, STEALTH uses anti-detection browser. Example: "lite"
capture_config body · optional
Configure which data to capture during the run.
credential_item_ids body · optional
Scope vault credentials to specific credential URIs. Requires use_vault to be true. If omitted with use_vault: true, all enabled items are used.
goal body · required
Natural language description of what to accomplish on the website. Example: "Find the pricing page and extract all plan details"
output_schema body · optional
Optional provider-supported structured-output schema subset for the run result. Unsupported fields are rejected before the request is accepted.
profile_id body · optional
Browser Context Profile ID to use when use_profile is true. Example: "prof_abc123def4567890"
proxy_config body · optional
Proxy configuration
url body · required
Target website URL to automate. Example: "https://example.com"
use_profile body · optional
Opt-in to the default Browser Context Profile if Browser Context Profiles are enabled; legacy callers are silently ignored when the profiles feature is disabled. Returns 400 when enabled but no default profile is set. Example: true
use_vault body · optional
Opt-in to vault credentials for this run. When true, enabled vault items are included. Defaults to false. Example: true
webhook_url body · optional
HTTPS URL to receive webhook notifications for run lifecycle events. Must use HTTPS.

Provider docs How to run it