Fetches Open Graph-style link preview metadata for a URL.
Parameters
Output
Encoding
application/jsondescription
string
Optional
No description available.
image
array
Required
No description available.
largeImage
boolean
Optional
No description available.
siteName
string
Optional
No description available.
themeColor
string
Optional
No description available.
title
string
Optional
No description available.
Errors
AuthRequired
Missing, malformed, or unverifiable service auth. InvalidRequest
A parameter or body field was missing or malformed. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "query",
"errors": [
{
"name": "AuthRequired",
"description": "Missing, malformed, or unverifiable service auth."
},
{
"name": "InvalidRequest",
"description": "A parameter or body field was missing or malformed."
}
],
"output": {
"schema": {
"type": "object",
"required": [
"image"
],
"properties": {
"image": {
"type": "array",
"items": {
"ref": "lex:social.colibri.embed.defs#embedImage",
"type": "ref"
}
},
"title": {
"type": "string"
},
"siteName": {
"type": "string"
},
"largeImage": {
"type": "boolean"
},
"themeColor": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"required": [
"uri"
],
"properties": {
"uri": {
"type": "string"
}
}
},
"description": "Fetches Open Graph-style link preview metadata for a URL."
}