Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tinyfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Search does not use credits.
The TinyFish Search API lets you run web searches and get back structured results — titles, snippets, and URLs — ready for LLM consumption or programmatic use. 
GET https://api.search.tinyfish.ai
api.search.tinyfish.ai is the public Search API endpoint.

​
Before You Start

1

Get your API key

Visit agent.tinyfish.ai/api-keys and create a key. Store it in your environment:
export TINYFISH_API_KEY="your_api_key_here"
All requests require the X-API-Key header. See Authentication for the full setup and troubleshooting guide.

​
Your First Request

from tinyfish import TinyFish

client = TinyFish()
response = client.search.query(query="web automation tools")
for r in response.results:
    print(r.title, "→", r.url)

​
What Success Looks Like

{
  "query": "web automation tools",
  "results": [
    {
      "position": 1,
      "site_name": "tinyfish.ai",
      "title": "TinyFish — AI Web Automation Platform",
      "snippet": "Automate any website with natural language instructions...",
      "url": "https://tinyfish.ai"
    },
    {
      "position": 2,
      "site_name": "github.com",
      "title": "Top Web Automation Tools in 2026",
      "snippet": "A curated list of browser automation frameworks...",
      "url": "https://github.com/example/web-automation-tools"
    }
  ],
  "total_results": 10
}

​
When to Use Search vs the Other APIs

  • Use Search when you need ranked search engine results, snippets, and URLs.
  • Use Fetch when you already have the URLs and want extracted page content.
  • Use Agent when you want TinyFish to browse and execute a workflow on the site.
  • Use Browser when you need direct browser control from your own code.

​
Geo-Targeted Results

Use the location and language parameters to get results tailored to a specific region. 
from tinyfish import TinyFish

client = TinyFish()
response = client.search.query(
    query="best restaurants",
    location="FR",
    language="fr",
)

API Reference

Full request and response schema

Authentication

API key setup

For coding agents

One page that routes an agent to the right TinyFish API