social.colibri.beta.embed.getMetadata
Fetches and parses a link preview. The AppView fetches the URL on the client's behalf, so the client's address is never exposed to the target site.
Details · query
| Kind | query |
|---|---|
| Authority | embed.beta.colibri.social |
| Indexed |
Checks
Valid Lint pass{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Fetches and parses a link preview. The AppView fetches the URL on the client's behalf, so the client's address is never exposed to the target site.",
"errors": [
{
"description": "The request has no valid service auth.",
"name": "AuthRequired"
},
{
"description": "The arguments are inconsistent or malformed beyond schema validation.",
"name": "InvalidRequest"
},
{
"description": "The target refused the request, timed out, or resolves to an address the AppView will not fetch.",
"name": "NotFetchable"
},
{
"description": "The target site failed while the AppView fetched or parsed it.",
"name": "UpstreamFailure"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"embed": {
"description": "The parsed preview.",
"ref": "social.colibri.beta.embed.defs#linkEmbed",
"type": "ref"
}
},
"required": [
"embed"
],
"type": "object"
}
},
"parameters": {
"properties": {
"uri": {
"description": "The URL to preview.",
"format": "uri",
"type": "string"
}
},
"required": [
"uri"
],
"type": "params"
},
"type": "query"
}
},
"id": "social.colibri.beta.embed.getMetadata",
"lexicon": 1
}