Discohook
  1. Link Preview
Discohook
  • Discohook API
  • Reference
  • Discohook CDN
  • Using Discohook as an external message designer or previewer
  • Changelog
  • Share Links
    • Create Share Link
      POST
    • Get Share Link
      GET
  • Link Preview
    • Unfurl URL Embed
      GET
  • GitHub
    • Execute GitHub-Compatible Webhook in Forum Channel
      POST
  1. Link Preview

Unfurl URL Embed

Developing
Production
https://discohook.app/api/v1
Production
https://discohook.app/api/v1
GET
https://discohook.app/api/v1
/unfurl
This is a reasonably faithful re-implementation of Discord's web scraper. This endpoint may eventually require authorization.

Notes#

Unfortunately, Discord's real scraper is notoriously ignorant of robots.txt and the like, so in order to match functionality, the robots.txt file is also ignored in this re-implementation (for now). Additionally, because Discohook does not pretend to be Discordbot (or a real browser), many Discord- or real-browser- specific responses will not appear as they do in Discord.

Request

Query Params
url
string <uri>
required
http(s) URL of the resource to unfurl

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://discohook.app/api/v1/unfurl?url'

Responses

🟢200Success
application/json
Body
embeds
array [object {11}] 
required
type
enum<string> 
optional
Allowed values:
richimagevideogifvarticlelink
title
string 
optional
description
string 
optional
color
integer 
optional
author
object 
optional
fields
array [object {3}] 
optional
footer
object 
optional
timestamp
string <date-time>
optional
image
object 
optional
thumbnail
object 
optional
provider
object 
optional
Example
{
    "embeds": [
        {
            "type": "rich",
            "title": "string",
            "description": "string",
            "color": 0,
            "author": {
                "name": "string",
                "url": "string",
                "icon_url": "string"
            },
            "fields": [
                {
                    "name": "string",
                    "value": "string",
                    "inline": true
                }
            ],
            "footer": {
                "text": "string",
                "icon_url": "string"
            },
            "timestamp": "2019-08-24T14:15:22Z",
            "image": {
                "url": "string"
            },
            "thumbnail": {
                "url": "string"
            },
            "provider": {
                "name": "string",
                "url": "string"
            }
        }
    ]
}
Modified at 2024-08-03 19:26:42
Previous
Get Share Link
Next
Execute GitHub-Compatible Webhook in Forum Channel
Built with