link.latr.preview.getOpenGraph Documentation (EN)

main query

L@tr XRPC method link.latr.preview.getOpenGraph.

Parameters

url string uri Required

A valid URI.

Output

Encodingapplication/json

author string Optional

No description available.

description string Optional

No description available.

image stringuri Optional

A valid URI.

siteName string Optional

No description available.

title string Optional

No description available.

Errors

InvalidRequest

InvalidUrl

AuthRequired

InvalidToken

InvalidDpop

ClientAuthRequired

SavedItemNotFound

Conflict

RateLimitExceeded

UpstreamFailure

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

url * A valid URI.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "InvalidRequest"
    },
    {
      "name": "InvalidUrl"
    },
    {
      "name": "AuthRequired"
    },
    {
      "name": "InvalidToken"
    },
    {
      "name": "InvalidDpop"
    },
    {
      "name": "ClientAuthRequired"
    },
    {
      "name": "SavedItemNotFound"
    },
    {
      "name": "Conflict"
    },
    {
      "name": "RateLimitExceeded"
    },
    {
      "name": "UpstreamFailure"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [],
      "properties": {
        "image": {
          "type": "string",
          "format": "uri",
          "maxLength": 8192,
          "maxGraphemes": 2048
        },
        "title": {
          "type": "string",
          "maxLength": 2048,
          "maxGraphemes": 512
        },
        "author": {
          "type": "string",
          "maxLength": 512,
          "maxGraphemes": 128
        },
        "siteName": {
          "type": "string",
          "maxLength": 512,
          "maxGraphemes": 128
        },
        "description": {
          "type": "string",
          "maxLength": 8192,
          "maxGraphemes": 2048
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "url"
    ],
    "properties": {
      "url": {
        "type": "string",
        "format": "uri",
        "maxLength": 8192,
        "maxGraphemes": 2048
      }
    }
  },
  "description": "L@tr XRPC method link.latr.preview.getOpenGraph."
}