Linkup

AI API key Linkup documentation

Give your Windmill scripts, flows and AI agents real-time web search, page fetching and multi-step research with Linkup.

Set up in 3 steps

1

Get your credential

Sign in to app.linkup.so and copy your API key from the dashboard.

2

Add the resource in Windmill

Open Resources, add a resource of type linkup, and paste the key into the token field.

3

Run your first script

Start with Search at depth fast, or Get credits balance to check the key works.

Scripts

Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.

Submit a script →

Resource type

The shape of the credential every script on this page expects.

FieldTypeRequiredWhat it is
tokenstringYesLinkup API key, from the API key section of the Linkup dashboard.

Questions

Which depth should I pick?

flash and fast answer in under a second and suit most agents. standard and deep run agentic search passes for multi-source questions, and cost more credits.

How do I get JSON back instead of text?

Set output_type to structured and pass a JSON schema in Search or Create research task. Fetch page takes a schema too, and returns the matching fields under data.

Can I limit a search to specific sites or dates?

Yes. include_domains and exclude_domains take up to 100 domains each, and from_date and to_date take YYYY-MM-DD dates.

Fetch page comes back empty or incomplete

The page probably builds its content with JavaScript. Turn on render_js, or switch mode to pro for pages that are hard to retrieve.

Research and batch tasks return no answer

They run asynchronously. The create script returns an id; call Get research task or Get task with it until the status is completed. A research task can take a couple of minutes.

I get a 429 error

You hit the rate limit or ran out of credits. Run Get credits balance to tell which.

Is my credential stored on the hub?

Never. It lives only in your own Windmill workspace, encrypted at rest.