Search
The /search endpoint allows you to retrieve web content.
Example code
// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";
const orthogonal = new Orthogonal({
apiKey: process.env.ORTHOGONAL_API_KEY,
});
const output = await orthogonal.run({
api: "linkup",
path: "/search",
body: {
"q": "example",
"depth": "example",
"outputType": "example"
}
});
console.log(output);Body parameters
The natural language question for which you want to retrieve context.
Defines the precision of the search. standard returns results faster; deep takes longer but yields more comprehensive results.
The type of output you want to get. Use structured for a custom-formatted response defined by structuredOutputSchema.
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.
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
Defines whether the API should include images in its results.
The date from which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be before toDate, if provided, and later than 1970-01-01.
The date until which the search results should be considered, in ISO 8601 format (YYYY-MM-DD). It must be later than fromDate, if provided, or than 1970-01-01.
The domains you want to search on. By default, don't restrict the search. You can provide up to 100 domains.
The domains you want to exclude of the search. By default, don't restrict the search.
Relevant only when outputType is sourcedAnswer. Defines whether the answer should include inline citations.
The maximum number of results to return.
Response
Array of search results. Returned when outputType is searchResults.
Title of the source page.
URL of the source page.
Extracted content snippet from the source.
LLM-composed answer with source attribution. Returned when outputType is sourcedAnswer.
Array of sources used to compose the answer. Returned when outputType is sourcedAnswer or when includeSources is true with structured output.
Title of the source page.
URL of the source page.
Relevant excerpt from the source.
Array of images found in search results. Only present when includeImages is true.
URL of the image.
Alt text of the image.