Skip to main content
Linkup logo

​
Overview

Add Linkup to any ModuleX agent or workflow. Web search for AI agents — retrieve up-to-date information from across the web with source attribution, via the Linkup REST API (api.linkup.so/v1).
Categories: Web Search & Scraping · Data · Search · Auth: API Key · Actions: 1

​
Authentication

​
API Key Authentication

Authenticate using your Linkup API key
1

Step 1

Go to https://app.linkup.so and sign up or log in
2

Step 2

Open the API Keys section of your dashboard
3

Step 3

Create a new API key or copy your existing one
4

Step 4

Paste the API key below

​
Required Credentials

FieldDescriptionRequiredFormat
Linkup API KeyYour Linkup API key from app.linkup.soYes-

​
Available Actions

​
Parameters

​
q
string
required
The search query (e.g., “latest AI research papers 2024”)
​
depth
string
Search depth: “standard” for quick results, “deep” for comprehensive search (also supports “fast”) (Default: standard)
​
output_type
string
Output format: “sourcedAnswer” for an AI-generated answer with citations, “searchResults” for raw results, or “structured” (Default: sourcedAnswer)
​
include_images
boolean
Whether to include images in search results
​
include_inline_citations
boolean
Add inline citations to answers (only applies when output_type is “sourcedAnswer”)
​
include_sources
boolean
Include sources in the response
​
from_date
string
Start date for filtering results (YYYY-MM-DD format)
​
to_date
string
End date for filtering results (YYYY-MM-DD format)
​
include_domains
string
Comma-separated list of domain names to restrict search results to
​
exclude_domains
string
Comma-separated list of domain names to exclude from search results

​
Response

{
  "$defs": {
    "SearchResultItem": {
      "additionalProperties": false,
      "description": "A single result row in a ``searchResults`` response.",
      "properties": {
        "type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Type"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url"
        },
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Content"
        }
      },
      "title": "SearchResultItem",
      "type": "object"
    },
    "SearchSource": {
      "additionalProperties": false,
      "description": "A citation in a ``sourcedAnswer`` response's ``sources`` array.",
      "properties": {
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url"
        },
        "snippet": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Snippet"
        }
      },
      "title": "SearchSource",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "answer": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Answer"
    },
    "sources": {
      "items": {
        "$ref": "#/$defs/SearchSource"
      },
      "title": "Sources",
      "type": "array"
    },
    "results": {
      "items": {
        "$ref": "#/$defs/SearchResultItem"
      },
      "title": "Results",
      "type": "array"
    },
    "structured_data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Structured Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchOutput",
  "type": "object"
}

​
Limits & Quotas

  • Rate limit: ~60 requests/min.
  • Depth tiers: standard queries are cheaper and faster; deep queries cost more and take longer.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising. Plan for retries on the agent side based on the error string.

Exa Search

Firecrawl

Serper