---
title: "Oembed"
method: GET
path: "/api/oembed"
tags: ["oembed"]
---

# Oembed

`GET /api/oembed`

## Request

- Base URL: `https://app.getdot.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://app.getdot.ai/api/oembed`
- Auth: one of:
  - API key in header `X-API-KEY`
  - API key in cookie `Authorization`
  - OAuth 2 (password, token URL `/api/auth/token`)

oEmbed provider endpoint. Returns embed metadata for a Dot share URL.

Supports the JSON format only; per the spec, an unsupported `format` yields
501. The `url` must point at one of Dot's own hosts, or we 404 (no open
proxy). Gating and cache headers mirror the underlying share page.

## Query parameters

- `url` string, required: The Dot share URL to embed
- `maxwidth` integer, nullable
- `maxheight` integer, nullable
- `format` string

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getdot/apis/dot-api-2.md) · [All operations](https://skmtc.dev/getdot/apis/dot-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/getdot/apis/dot-api-2/revisions/d26fe7163a7f?raw)