GEgetstream
product:chat

Get OG

Changed on

Get an OpenGraph attachment for a link

get/og

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/og
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Query parameters

urlstring required

URL to be scraped

Response

Get OG Attachment

asset_urlstring

URL of detected video or audio

author_iconstring
author_linkstring

og:site

author_namestring

og:site_name

colorstring
customobject required
durationstring required
fallbackstring
footerstring
footer_iconstring
image_urlstring

URL of detected image

og_scrape_urlstring

extracted url from the text

original_heightinteger
original_widthinteger
pretextstring
textstring

og:description

thumb_urlstring

URL of detected thumb image

titlestring

og:title

title_linkstring

og:url

typestring

Attachment type, could be empty, image, audio or video

Changes

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ecf82915c7e4Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status