POST
/
search

Get your API key

Create a Linkup account for free to get your API key.

The /search endpoint is a context retrieve for online content. For a natural language query, it finds online information to ground your LLM’s answer, along with sources.

Depending on the depth parameter, results may be faster (standard) or slower but more complete (deep). If outputType is set to structured, you may provide a structuredOutputSchema to dictate the response format.

Learn more about these parameters in Concepts.

Authorizations

Authorization
string
header
required

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

Body

application/json
depth
enum<string>
required

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

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

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

Available options:
sourcedAnswer,
searchResults,
structured
q
string
required

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

includeImages
boolean

Defines whether the API should include images in its results.

structuredOutputSchema
string

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.

Response

200 - application/json

When you pick searchResults for the outputType parameter, you will get a list of search results related to your query.

results
object[]