# TinyFish Web Agent

## Docs

- [Agent API](https://docs.tinyfish.ai/agent-api/index.md): Use natural-language goals to automate workflows on real websites
- [Agent API Reference](https://docs.tinyfish.ai/agent-api/reference.md): Technical reference for goal-based TinyFish automation
- [Anti-Bot Guide](https://docs.tinyfish.ai/anti-bot-guide.md): Diagnose and bypass bot detection when automating protected websites
- [Run browser automation synchronously](https://docs.tinyfish.ai/api-reference/automation/run-browser-automation-synchronously.md): 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 cancell…
- [Run browser automation with SSE streaming](https://docs.tinyfish.ai/api-reference/automation/run-browser-automation-with-sse-streaming.md): Execute a browser automation task with Server-Sent Events (SSE) streaming. Returns a real-time event stream with automation progress, browser streaming URL, and final results.
- [Start automation asynchronously](https://docs.tinyfish.ai/api-reference/automation/start-automation-asynchronously.md): Creates and enqueues an automation run, returning the run_id immediately without waiting for completion. Use this for long-running automations where you want to poll for results separately.
- [Start multiple automations asynchronously](https://docs.tinyfish.ai/api-reference/automation/start-multiple-automations-asynchronously.md): Creates and enqueues multiple automation runs in a single request, returning run_ids immediately without waiting for completion. Maximum 100 runs per request.
- [Create a remote browser session](https://docs.tinyfish.ai/api-reference/create-a-remote-browser-session.md): Creates a remote tf-browser session and returns CDP connection details. Optionally accepts a target URL to select the best proxy for that domain. Connect to the browser via CDP WebSocket at `cdp_url`.
- [Fetch and extract content from URLs](https://docs.tinyfish.ai/api-reference/fetch-and-extract-content-from-urls.md): Renders web pages using a real browser (including JavaScript-heavy sites) and returns clean extracted content in your preferred format. Submit up to 10 URLs, get back structured content. Per-URL failures appear in `errors[]` and do not fail the entire request.
- [List browser session usage](https://docs.tinyfish.ai/api-reference/list-browser-session-usage.md): List Tetra browser session usage for the authenticated user. Returns session telemetry including duration, data transfer, mode, and status.
- [List fetch usage](https://docs.tinyfish.ai/api-reference/list-fetch-usage.md): List fetch usage records for the authenticated user. Returns paginated results with URL, format, status, and metadata for each fetch operation.
- [List search usage](https://docs.tinyfish.ai/api-reference/list-search-usage.md): List search usage records for the authenticated user. Returns paginated results with query details, status, and result counts.
- [Cancel multiple runs by IDs](https://docs.tinyfish.ai/api-reference/runs/cancel-multiple-runs-by-ids.md): Cancel multiple runs by their IDs in a single request. Returns per-run results including cancelled runs, already-terminal runs, and not-found IDs. Maximum 100 IDs per request. Idempotent: calling twice returns consistent results.
- [Cancel run by ID](https://docs.tinyfish.ai/api-reference/runs/cancel-run-by-id.md): Cancel a run by ID. Only runs created via `/v1/automation/run-async` or `/v1/automation/run-sse` can be cancelled. Runs created via the synchronous `/v1/automation/run` endpoint cannot be cancelled.
- [Get multiple runs by IDs](https://docs.tinyfish.ai/api-reference/runs/get-multiple-runs-by-ids.md): Retrieve multiple runs by their IDs in a single request. Returns found runs and lists any IDs that were not found or not owned. Maximum 100 IDs per request.
- [Get run by ID](https://docs.tinyfish.ai/api-reference/runs/get-run-by-id.md): Get detailed information about a specific automation run by its ID.
- [List and search runs](https://docs.tinyfish.ai/api-reference/runs/list-and-search-runs.md): List automation runs with optional filtering by status, goal text, and date range. Returns paginated results with total count. Default sort order is newest first.
- [Search the web](https://docs.tinyfish.ai/api-reference/search-the-web.md): Search the web and get structured results. Returns ranked results with titles, snippets, and URLs.
- [Terminate a browser session](https://docs.tinyfish.ai/api-reference/terminate-a-browser-session.md): Terminates a remote browser session immediately. If the session is already ended this call is idempotent and still returns 204.
- [Connect a vault provider](https://docs.tinyfish.ai/api-reference/vault/connect-a-vault-provider.md): Connect a supported password manager and immediately sync display-safe credential metadata.
- [Disconnect a vault provider](https://docs.tinyfish.ai/api-reference/vault/disconnect-a-vault-provider.md): Disconnect a vault provider and remove its stored enabled items.
- [List vault connections](https://docs.tinyfish.ai/api-reference/vault/list-vault-connections.md): List all connected vault providers for the authenticated user.
- [List vault items](https://docs.tinyfish.ai/api-reference/vault/list-vault-items.md): List all vault items currently available from connected providers.
- [Sync vault items](https://docs.tinyfish.ai/api-reference/vault/sync-vault-items.md): Sync items from connected providers and return merged item state plus sync counters.
- [Authentication](https://docs.tinyfish.ai/authentication.md): How to authenticate with the TinyFish API
- [Browser Examples](https://docs.tinyfish.ai/browser-api/examples.md): Real-world examples for the Browser API
- [Browser API](https://docs.tinyfish.ai/browser-api/index.md): Create a remote browser session and control it programmatically
- [Browser API Reference](https://docs.tinyfish.ai/browser-api/reference.md): Complete reference for the Browser API endpoints
- [CLI Commands](https://docs.tinyfish.ai/cli/commands.md): Full reference for TinyFish CLI commands
- [CLI](https://docs.tinyfish.ai/cli/index.md): Run TinyFish automations directly from your terminal
- [Common Patterns](https://docs.tinyfish.ai/common-patterns.md): Ready-to-use code patterns for common TinyFish Web Agent use cases
- [Error Codes](https://docs.tinyfish.ai/error-codes.md): API error codes and how to resolve them
- [Async Bulk Requests](https://docs.tinyfish.ai/examples/bulk-requests-async.md): Submit multiple runs and poll for results
- [Concurrent Requests](https://docs.tinyfish.ai/examples/bulk-requests-sync.md): Process multiple runs in parallel for better performance
- [Form Filling](https://docs.tinyfish.ai/examples/form-filling.md): Automate form filling and submission
- [Web Scraping](https://docs.tinyfish.ai/examples/scraping.md): Extract data from any website using natural language
- [Frequently Asked Questions](https://docs.tinyfish.ai/faq.md): Common questions about TinyFish Web Agent
- [Fetch Examples](https://docs.tinyfish.ai/fetch-api/examples.md): Real-world examples for the Fetch API
- [Fetch API](https://docs.tinyfish.ai/fetch-api/index.md): Render any URL and extract clean text — no external APIs required
- [Fetch API Reference](https://docs.tinyfish.ai/fetch-api/reference.md): Complete reference for the Fetch API endpoint
- [For Coding Agents](https://docs.tinyfish.ai/for-coding-agents.md): Single-page TinyFish context for Claude, Codex, Cursor, and other coding agents
- [TinyFish Developer Documentation](https://docs.tinyfish.ai/index.md): Choose the right TinyFish API, authenticate quickly, and start integrating faster
- [Dify](https://docs.tinyfish.ai/integrations/dify.md): Use TinyFish Web Agent as a tool in Dify AI workflows and agents
- [n8n](https://docs.tinyfish.ai/integrations/n8n.md): Use TinyFish Web Agent as a node in n8n automation workflows
- [Browser Profiles](https://docs.tinyfish.ai/key-concepts/browser-profiles.md): Configure browser behavior for different sites
- [Vault Credentials](https://docs.tinyfish.ai/key-concepts/credentials.md): How TinyFish uses your password manager credentials to log into websites during runs
- [Agent Endpoints](https://docs.tinyfish.ai/key-concepts/endpoints.md): Choose the right TinyFish Agent endpoint based on sync, async, or streaming needs
- [The Goal Parameter](https://docs.tinyfish.ai/key-concepts/goals.md): Natural language instructions that tell TinyFish Web Agent what to do
- [Proxies](https://docs.tinyfish.ai/key-concepts/proxies.md): Route requests through specific geographic locations
- [Runs](https://docs.tinyfish.ai/key-concepts/runs.md): The lifecycle of a TinyFish Web Agent automation
- [Structured Output](https://docs.tinyfish.ai/key-concepts/structured-output.md): Supported structured-output schema subset for the output_schema request field
- [Live Browser Preview](https://docs.tinyfish.ai/live-preview.md): Embed a real-time browser view in your app using the streaming URL
- [MCP Integration](https://docs.tinyfish.ai/mcp-integration/index.md): Integrate TinyFish Web Agent with your AI assistant
- [Goal Prompting Guide](https://docs.tinyfish.ai/prompting-guide.md): Write goals that make TinyFish Web Agent work like magic
- [Quick Start](https://docs.tinyfish.ai/quick-start.md): Get your first web automation running in under 5 minutes
- [Search Examples](https://docs.tinyfish.ai/search-api/examples.md): Real-world examples for the Search API
- [Search API](https://docs.tinyfish.ai/search-api/index.md): Search the web and get structured results via API
- [Search API Reference](https://docs.tinyfish.ai/search-api/reference.md): Complete reference for the Search API endpoint
- [Build with AI](https://docs.tinyfish.ai/using-with-ai.md): Give your AI coding assistant context on TinyFish Web Agent
- [Connect Your Vault](https://docs.tinyfish.ai/vault-setup.md): Connect your password manager so TinyFish can securely log into websites during automations
- [Webhooks](https://docs.tinyfish.ai/webhooks.md): Get notified when runs complete, fail, or are cancelled

## OpenAPI Specs

- [browser](https://docs.tinyfish.ai/openapi/browser.json)
- [main](https://docs.tinyfish.ai/openapi/main.json)
- [search](https://docs.tinyfish.ai/openapi/search.json)
- [fetch](https://docs.tinyfish.ai/openapi/fetch.json)
- [openapi](https://docs.tinyfish.ai/api-reference/openapi.json)

## Optional

- [Cookbook](https://github.com/tinyfish-io/tinyfish-cookbook)