social.colibri.beta.embed.getMetadata

colibri.social

Documentation

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.

main query

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.

Parameters

uri string uri Required

The URL to preview.

Output

Encodingapplication/json

Errors

AuthRequired The request has no valid service auth.
InvalidRequest The arguments are inconsistent or malformed beyond schema validation.
NotFetchable The target refused the request, timed out, or resolves to an address the AppView will not fetch.
UpstreamFailure The target site failed while the AppView fetched or parsed it.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The URL to preview.
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    },
    {
      "name": "InvalidRequest",
      "description": "The arguments are inconsistent or malformed beyond schema validation."
    },
    {
      "name": "NotFetchable",
      "description": "The target refused the request, timed out, or resolves to an address the AppView will not fetch."
    },
    {
      "name": "UpstreamFailure",
      "description": "The target site failed while the AppView fetched or parsed it."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "embed"
      ],
      "properties": {
        "embed": {
          "ref": "social.colibri.beta.embed.defs#linkEmbed",
          "type": "ref",
          "description": "The parsed preview."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "uri"
    ],
    "properties": {
      "uri": {
        "type": "string",
        "format": "uri",
        "description": "The URL to preview."
      }
    }
  },
  "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."
}

Lexicon Garden

@