🚀 Linkup JS/TS SDK

A JS/TS SDK for the Linkup API, allowing easy integration with Linkup's services.

🌟 Features

• ✅ Simple and intuitive API client.
• 🔍 Supports both standard and deep search queries.
• 🔒 Handles authentication and request management.

📦 Installation

Simply install the Linkup JS SDK using npm or any other package manager:

npm i linkup-sdk

📚 Documentation

Find the complete documentation here.

🛠️ Usage

Setting Up Your Environment

1. 🔑 Obtain an API Key:

Sign up on Linkup to get your API key.

2. ⚙️ Set-up the API Key:

Pass the Linkup API key to the Linkup Client when creating it.

import { LinkupClient } from 'linkup-js-sdk';

const client = new LinkupClient({
  apiKey: '<YOUR API KEY>',
});

📋 Search Endpoint

All search queries can be used with two very different modes:

• with standard depth, the search will be straightforward and fast, suited for relatively simple queries (e.g. "What's the weather in Paris today?")
• with deep depth, the search will use an agentic workflow, which makes it in general slower, but it will be able to solve more complex queries (e.g. "What is the company profile of LangChain accross the last few years, and how does it compare to its concurrents?")

📝 Example standard search query

import { LinkupClient } from 'linkup-js-sdk';

const client = new LinkupClient({
  apiKey: '<YOUR API KEY>',
});

const askLinkup = () => client.search({
  query: 'Can you tell me which women were awared the Physics Nobel Prize',
  depth: 'standard',
  outputType: 'sourcedAnswer',
});

askLinkup()
  .then(console.log);
  .catch(console.error);

⬇️ Fetch Endpoint

You can use the fetch endpoint to retrieve the content of a given URL in clean markdown format.

Use renderJs to execute the JavaScript code of the page before returning the content.

Use includeRawHtml to get the raw HTML of the page.

Use extractImages to get an extracted list of images from the page.

📝 Example

import { LinkupClient } from 'linkup-js-sdk';

const client = new LinkupClient({
  apiKey: '<YOUR API KEY>',
});

const fetchLinkup = async () => client.fetch({
  url: 'https://docs.linkup.so',
  renderJs: true,
});

fetchLinkup()
  .then(console.log)
  .catch(console.error);