Skip to main content
POST
/
v1
/
fetch
/fetch
curl --request POST \
  --url https://api.linkup.so/v1/fetch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://docs.linkup.so",
  "renderJs": false,
  "includeRawHtml": false,
  "extractImages": false
}'
{
  "markdown": "Get started for free, no credit card required...",
  "rawHtml": "<!DOCTYPE html><html lang=\"en\"><head>...</head><body>...</body></html>",
  "images": [
    {
      "alt": "Image 1",
      "url": "https://example.com/image.jpg"
    },
    {
      "alt": "Image 2",
      "url": "https://example.com/image2.jpg"
    }
  ]
}

Get your API key

Create a Linkup account for free to get your API key.
 The /fetch endpoint retrieves a markdown representation of a webpage at the given URL, with the ability to render the Javascript or not.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
url
string<uri>
required

The URL of the webpage you want to fetch.

Example:

"https://docs.linkup.so"

​
renderJs
boolean
default:false

Defines whether the API should render the JavaScript of the webpage.

Example:

false

​
includeRawHtml
boolean
default:false

Defines whether the API should include the raw HTML of the webpage in its response.

Example:

false

​
extractImages
boolean
default:false

Defines whether the API should extract the images from the webpage in its response.

Example:

false

Response

Successful response

​
markdown
string
required

The clean markdown version of the webpage.

Example:

"Get started for free, no credit card required..."

​
rawHtml
string

The raw HTML version of the webpage.

Example:

"<!DOCTYPE html><html lang=\"en\"><head>...</head><body>...</body></html>"

​
images
object[]

List of images extracted from the webpage.

Example:
[
  {
    "alt": "Image 1",
    "url": "https://example.com/image.jpg"
  },
  {
    "alt": "Image 2",
    "url": "https://example.com/image2.jpg"
  }
]