read); new accounts get free credits for 30 days.
Things to know:
- Search terms. Every search takes
q.web.searchalso takes Google’snum(about 10 per page at most),start(offset; 10 is page two),gl(country) andhl(language). Google operators such assite:work inq. - Region and device.
proxy_location(US, DE, GB, …) anddevice(desktop or mobile) set where Google thinks the search comes from. Withoutglor a region, results can change between calls. - Answers.
images.search,places.searchandarticles.searchreturn a fixed set of fields per row (the ones they store). Every other operation returns Serply’s JSON as it came, with the main list typed (results,jobs,products,entries, Redditdata.children) and every other field kept. - Reddit.
reddit.subredditPostsandreddit.userPostspage withafter(the previous answer’sdata.after);reddit.posttakeswith_comments. - Pages.
pages.fetchreturns the page indata, as markdown (response_type: markdown) or HTML (full, which also returns the page’s HTTP status). - Stored rows. Images, places and Scholar articles are stored locally; phone numbers and author names are not. Search terms are never written to events, and a failed call drops them from the error.
- 16 typed API operations
- 3 synced entities (
articles,images,places) for fast.search()/.list()
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the Serply API key before the first call: More: API Key
pnpm corsair setup --plugin=serply --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
Search GoogleQuery synced data
Synced entities supporttenant.serply.db.<entity>.search() and .list(): articles, images, places.
See Database for filters and operators.
What’s next
API reference
Every
serply.api.* operation with input and output types.Database
Synced entities, search filters, and operators.
Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.