---
title: "Get OG"
method: GET
path: "/og"
tags: ["product:chat"]
---

# Get OG

`GET /og`

Get an OpenGraph attachment for a link

## Query parameters

- `url` string, required — URL to be scraped

## Response `200`

Get OG Attachment

- GetOGResponse, nullable
  - `actions` Action[]
    - `name` string, required
    - `style` string
    - `text` string, required
    - `type` string, required
    - `value` string
  - `asset_url` string — URL of detected video or audio
  - `author_icon` string
  - `author_link` string — og:site
  - `author_name` string — og:site_name
  - `color` string
  - `custom` object, required
  - `duration` string, required
  - `fallback` string
  - `fields` Field[]
    - `short` boolean, required
    - `title` string, required
    - `value` string, required
  - `footer` string
  - `footer_icon` string
  - `giphy` Images
    - `fixed_height` ImageData, required
      - `frames` string, required
      - `height` string, required
      - `size` string, required
      - `url` string, required
      - `width` string, required
    - `fixed_height_downsampled` ImageData, required
      - `frames` string, required
      - `height` string, required
      - `size` string, required
      - `url` string, required
      - `width` string, required
    - `fixed_height_still` ImageData, required
      - `frames` string, required
      - `height` string, required
      - `size` string, required
      - `url` string, required
      - `width` string, required
    - `fixed_width` ImageData, required
      - `frames` string, required
      - `height` string, required
      - `size` string, required
      - `url` string, required
      - `width` string, required
    - `fixed_width_downsampled` ImageData, required
      - `frames` string, required
      - `height` string, required
      - `size` string, required
      - `url` string, required
      - `width` string, required
    - `fixed_width_still` ImageData, required
      - `frames` string, required
      - `height` string, required
      - `size` string, required
      - `url` string, required
      - `width` string, required
    - `original` ImageData, required
      - `frames` string, required
      - `height` string, required
      - `size` string, required
      - `url` string, required
      - `width` string, required
  - `image_url` string — URL of detected image
  - `og_scrape_url` string — extracted url from the text
  - `original_height` integer
  - `original_width` integer
  - `pretext` string
  - `text` string — og:description
  - `thumb_url` string — URL of detected thumb image
  - `title` string — og:title
  - `title_link` string — og:url
  - `type` string — Attachment type, could be empty, image, audio or video

## Other responses

- `400` — Bad request
- `429` — Too many requests

---

[API](https://skmtc.net/getstream/apis/stream-api.md) · [All operations](https://skmtc.net/getstream/apis/stream-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getstream/stream-api/versions/3dba86aaa0d8/schema)