---
title: "Resolve share oEmbed"
method: GET
path: "/shares/oembed"
tags: ["Shares"]
---

# Resolve share oEmbed

`GET /shares/oembed`

## Request

- Base URL: `https://api.aspect.inc`
- URL: `https://api.aspect.inc/shares/oembed`
- Auth: none required

Resolve a public share URL into oEmbed (https://oembed.com) embed metadata.

## Query parameters

- `url` string, required: Share URL to resolve into embed markup
- `format` string, nullable: Response format; only json is supported
- `maxwidth` integer, nullable: Maximum width of the embed in pixels
- `maxheight` integer, nullable: Maximum height of the embed in pixels

## Response `200`

Successful Response

- PublicShareOEmbedResponse: oEmbed (https://oembed.com) response describing how to embed a share URL.
  - `version` string: oEmbed protocol version
  - `type` string, required: oEmbed resource type (video or rich)
  - `title` string, required: Name of the shared asset
  - `provider_name` string, required: Display name of the embed provider
  - `provider_url` string, required: Base URL of the embed provider
  - `width` integer, required: Width in pixels of the embed html
  - `height` integer, required: Height in pixels of the embed html
  - `html` string, required: Iframe markup that renders the embed

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/aspect/apis/aspect-api.md) - [All operations](https://skmtc.dev/aspect/apis/aspect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aspect/apis/aspect-api/revisions/28ea5f1adb54?raw)