---
title: "Get link preview"
method: GET
path: "/"
tags: ["API Request"]
---

# Get link preview

`GET /`

Get a link preview

## Query parameters

- `q` string, required
- `key` string, required
- `fields` string

## Response `200`

successful response

- Response
  - `title` string, required — Website title. Available on all plans.
  - `description` string, required — Description summary. Available on all plans.
  - `image` string, required — Preview image URL. Available on all plans.
  - `url` string, required — Destination URL. Available on all plans.

## Other responses

- `400` — Generic error
- `401` — Cannot verify API access key
- `403` — Invalid or blank API access key
- `423` — Forbidden by robots.txt - the requested website does not allow us to access this page. See [robots exclusion standard](https://en.wikipedia.org/wiki/Robots_exclusion_standard).
- `425` — Invalid response status code (with the actual response code we got from the remote server)
- `426` — Too many requests per second on a single domain
- `429` — Too many requests / rate limit exceeded

---

[API](https://skmtc.dev/linkpreview/apis/linkpreview-api.md) · [All operations](https://skmtc.dev/linkpreview/apis/linkpreview-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/linkpreview/linkpreview-api/revisions/e45251b57eb6/schema)