app.bsky.embed.external

bsky-lexicons.bsky.social

Documentation

A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).

main object

A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).

Properties

external ref #external Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "external"
  ],
  "properties": {
    "external": {
      "ref": "#external",
      "type": "ref"
    }
  },
  "description": "A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post)."
}
colorRGB object

RGB color definition, inspired by site.standard.theme.color#rgb

Properties

b integer Required

No description available.

minimum: 0maximum: 255
g integer Required

No description available.

minimum: 0maximum: 255
r integer Required

No description available.

minimum: 0maximum: 255
View raw schema
{
  "type": "object",
  "required": [
    "r",
    "g",
    "b"
  ],
  "properties": {
    "b": {
      "type": "integer",
      "maximum": 255,
      "minimum": 0
    },
    "g": {
      "type": "integer",
      "maximum": 255,
      "minimum": 0
    },
    "r": {
      "type": "integer",
      "maximum": 255,
      "minimum": 0
    }
  },
  "description": "RGB color definition, inspired by site.standard.theme.color#rgb"
}
external object

No description available.

Properties

associatedRefs array of refcom.atproto.repo.strongRef Optional

StrongRefs (uri+cid) of the Atmosphere records that backed this view.

description string Required

No description available.

thumb blob Optional

No description available.

maxSize: 1.0 MB
title string Required

No description available.

uri string uri Required

A valid URI.

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "title",
    "description"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri"
    },
    "thumb": {
      "type": "blob",
      "accept": [
        "image/*"
      ],
      "maxSize": 1000000
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "associatedRefs": {
      "type": "array",
      "items": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref"
      },
      "description": "StrongRefs (uri+cid) of the Atmosphere records that backed this view."
    }
  }
}
view object

No description available.

Properties

View raw schema
{
  "type": "object",
  "required": [
    "external"
  ],
  "properties": {
    "external": {
      "ref": "#viewExternal",
      "type": "ref"
    }
  }
}
viewExternal object

No description available.

Properties

associatedRefs array of refcom.atproto.repo.strongRef Optional

StrongRefs (uri+cid) of the Atmosphere records that backed this view.

createdAt string datetime Optional

When the external content was created, if available. Example: a publication date, for an article.

description string Required

No description available.

readingTime integer Optional

Estimated reading time in minutes, if applicable and available.

thumb string uri Optional

A valid URI.

title string Required

No description available.

updatedAt string datetime Optional

When the external content was updated, if available.

uri string uri Required

A valid URI.

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "title",
    "description"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri"
    },
    "thumb": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "source": {
      "ref": "#viewExternalSource",
      "type": "ref"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the external content was created, if available. Example: a publication date, for an article."
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the external content was updated, if available."
    },
    "description": {
      "type": "string"
    },
    "readingTime": {
      "type": "integer",
      "description": "Estimated reading time in minutes, if applicable and available."
    },
    "associatedRefs": {
      "type": "array",
      "items": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref"
      },
      "description": "StrongRefs (uri+cid) of the Atmosphere records that backed this view."
    },
    "associatedProfiles": {
      "type": "array",
      "items": {
        "ref": "app.bsky.actor.defs#profileViewBasic",
        "type": "ref"
      },
      "description": "Profiles of the owners of the Atmosphere records that backed this view."
    }
  }
}
viewExternalSource object

The source of an external embed, such as a standard.site publication.

Properties

description string Optional

No description available.

icon string uri Optional

Fully-qualified URL where an icon representing the source can be fetched. For example, CDN location provided by the App View.

title string Required

No description available.

uri string uri Required

URI of the source, if available. Example: the https:// URL of a site.standard.publication record.

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "title"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "URI of the source, if available. Example: the https:// URL of a site.standard.publication record."
    },
    "icon": {
      "type": "string",
      "format": "uri",
      "description": "Fully-qualified URL where an icon representing the source can be fetched. For example, CDN location provided by the App View."
    },
    "theme": {
      "ref": "#viewExternalSourceTheme",
      "type": "ref"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "description": "The source of an external embed, such as a standard.site publication."
}
viewExternalSourceTheme object

The theme colors of an external source, such as a site.standard.publication. These colors may be used when rendering an embed from that source.

Properties

accentForegroundRGB ref #colorRGB Optional

No description available.

accentRGB ref #colorRGB Optional

No description available.

backgroundRGB ref #colorRGB Optional

No description available.

foregroundRGB ref #colorRGB Optional

No description available.

View raw schema
{
  "type": "object",
  "properties": {
    "accentRGB": {
      "ref": "#colorRGB",
      "type": "ref"
    },
    "backgroundRGB": {
      "ref": "#colorRGB",
      "type": "ref"
    },
    "foregroundRGB": {
      "ref": "#colorRGB",
      "type": "ref"
    },
    "accentForegroundRGB": {
      "ref": "#colorRGB",
      "type": "ref"
    }
  },
  "description": "The theme colors of an external source, such as a site.standard.publication. These colors may be used when rendering an embed from that source."
}

Lexicon Garden

@