---
title: "Resolve OpenGraph metadata for a URL"
method: GET
path: "/v1/unfurl"
tags: ["unfurl"]
---

# Resolve OpenGraph metadata for a URL

`GET /v1/unfurl`

## Query parameters

- `url` string, uri, required

## Response `200`

Successful response

- LinkPreview
  - `url` string, required
  - `title` string, nullable, required
  - `description` string, nullable, required
  - `image` string, nullable, required
  - `imageWidth` integer, nullable, required
  - `imageHeight` integer, nullable, required
  - `isPlayable` boolean
  - `siteName` string, nullable, required
  - `favicon` string, nullable, required

## Other responses

- `400` — Invalid input data
- `404` — Resource not found
- `500` — Internal server error

---

[API](https://skmtc.net/legend/apis/legend-api.md) · [All operations](https://skmtc.net/legend/apis/legend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/legend/legend-api/revisions/9651975196e7/schema)