Skip to main content
This page is the shortest high-signal context dump for coding agents integrating TinyFish. Use it when you want one page that explains which API to call, which endpoint to hit, and where to go next for deeper reference.
Mintlify also exposes /llms.txt and /llms-full.txt for this docs site. Start with this page when you want curated guidance, and use the llms files when your coding agent can ingest a larger machine-readable dump.

​
Choose the Right TinyFish API

APIUse it whenCanonical endpointDocs
AgentYou want TinyFish to execute a goal on a real websitePOST https://agent.tinyfish.ai/v1/automation/run-sseAgent reference
SearchYou want ranked web results for a queryGET https://api.search.tinyfish.aiSearch overview
FetchYou want extracted page content from one or more URLsPOST https://api.fetch.tinyfish.aiFetch overview
BrowserYou want a remote browser session for direct Playwright/CDP controlPOST https://api.browser.tinyfish.aiBrowser overview

​
Authentication

All public REST APIs use the same X-API-Key header. 
export TINYFISH_API_KEY="your_api_key_here"
Get a key from agent.tinyfish.ai/api-keys. See Authentication for the full setup and error handling details.

​
Minimal Request Examples

​
Agent

curl -N -X POST https://agent.tinyfish.ai/v1/automation/run-sse \
  -H "X-API-Key: $TINYFISH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://scrapeme.live/shop",
    "goal": "Extract the first 2 product names and prices. Return JSON."
  }'

curl "https://api.search.tinyfish.ai?query=web+automation+tools&location=US&language=en" \
  -H "X-API-Key: $TINYFISH_API_KEY"

​
Fetch

curl -X POST https://api.fetch.tinyfish.ai \
  -H "X-API-Key: $TINYFISH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls": ["https://www.tinyfish.ai/"]}'

​
Browser

curl -X POST https://api.browser.tinyfish.ai \
  -H "X-API-Key: $TINYFISH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://www.tinyfish.ai"}'

​
Fast Routing Rules

  • Use Agent when you want goal-based automation and TinyFish should decide the browser actions.
  • Use Search when you want ranked search results, snippets, and URLs.
  • Use Fetch when you want page content extracted from one or more URLs without running a goal-based agent.
  • Use Browser when you need low-level browser control from your own code.

Agent reference

Goal-based automation, endpoint choice, runs, profiles, and proxies

Authentication

API key setup and troubleshooting

Search overview

Search query parameters and result shape

Fetch overview

Fetch multiple URLs and choose output formats

Browser overview

Create a remote browser session and connect via CDP

Examples

Copy-paste examples for common workflows