Skip to main content
POST
/
v1
/
search
/search
curl --request POST \
  --url https://api.linkup.so/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "q": "What is Microsoft'\''s 2024 revenue?",
  "depth": "deep",
  "outputType": "searchResults",
  "structuredOutputSchema": null,
  "includeSources": false,
  "includeImages": false,
  "fromDate": "2025-01-01",
  "toDate": "2025-01-01",
  "includeDomains": [
    "microsoft.com",
    "agolution.com"
  ],
  "excludeDomains": [
    "wikipedia.com"
  ],
  "includeInlineCitations": false
}'
{
  "results": [
    {
      "type": "text",
      "name": "Microsoft 2024 Annual Report",
      "url": "https://www.microsoft.com/investor/reports/ar24/index.html",
      "content": "Highlights from fiscal year 2024 compared with fiscal year 2023 included: Microsoft Cloud revenue increased 23% to $137.4 billion."
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
q
string
required

The natural language question for which you want to retrieve context.

Example:

"What is Microsoft's 2024 revenue?"

​
depth
enum<string>
required

Defines the precision of the search. standard returns results faster; deep takes longer but yields more comprehensive results.

Available options:
deep,
standard
​
outputType
enum<string>
required

The type of output you want to get. Use structured for a custom-formatted response defined by structuredOutputSchema.

Available options:
searchResults,
sourcedAnswer,
structured
​
structuredOutputSchema
string<json>

Required only when outputType is structured. Provide a JSON schema (as a string) representing the desired response format. The root must be of type object.

​
includeSources
boolean
default:false

Relevant only when outputType is structured. Defines whether the response should include sources. Please note that it modifies the schema of the response, see below

​
includeImages
boolean
default:false

Defines whether the API should include images in its results.

​
fromDate
string

The date from which the search results should be considered, in ISO 8601 format (YYYY-MM-DD).

Example:

"2025-01-01"

​
toDate
string

The date until which the search results should be considered, in ISO 8601 format (YYYY-MM-DD).

Example:

"2025-01-01"

​
includeDomains
string[]

The domains you want to search on. By default, don't restrict the search.

Example:
["microsoft.com", "agolution.com"]
​
excludeDomains
string[]

The domains you want to exclude of the search. By default, don't restrict the search.

Example:
["wikipedia.com"]
​
includeInlineCitations
boolean
default:false

Relevant only when outputType is sourcedAnswer. Defines whether the answer should include inline citations.

Response

Successful response

​
results
object[]
required

List of search results.

  • Option 1
  • Option 2