Get Embed for URL - Guilded Client

Request

Query Params

url

string <uri>

required

The URL to get an embed for

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

A special embed shown when a link must be unfurled

ogTitle

string

optional

The title of the webpage (og:title)

ogDescription

string

optional

The description of the webpage (og:description)

ogSiteName

string

optional

The name of the site (og:site_name)

ogUrl

string

optional

The URL of the webpage

ogImage

object

optional

An image associated with the webpage. Not strictly og:image despite the property name, although it takes priority if present

url

string

optional

A proxied URL to the image

siteType

enum<string>

read-onlyoptional

A preset "type" of site from an enum, indicates to the client which icon to show at the top left

Allowed values:

facebookgithubguildedreddittwitchtwittervimeoyoutube

Example

{
  "ogTitle": "string",
  "ogDescription": "string",
  "ogSiteName": "string",
  "ogUrl": "string",
  "ogImage": {
    "url": "string"
  },
  "siteType": "facebook"
}