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
{
  "description": "A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post).",
  "properties": {
    "external": {
      "ref": "#external",
      "type": "ref"
    }
  },
  "required": [
    "external"
  ],
  "type": "object"
}
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
{
  "description": "RGB color definition, inspired by site.standard.theme.color#rgb",
  "properties": {
    "b": {
      "maximum": 255,
      "minimum": 0,
      "type": "integer"
    },
    "g": {
      "maximum": 255,
      "minimum": 0,
      "type": "integer"
    },
    "r": {
      "maximum": 255,
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "r",
    "g",
    "b"
  ],
  "type": "object"
}
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
{
  "properties": {
    "associatedRefs": {
      "description": "StrongRefs (uri+cid) of the Atmosphere records that backed this view.",
      "items": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref"
      },
      "type": "array"
    },
    "description": {
      "type": "string"
    },
    "thumb": {
      "accept": [
        "image/*"
      ],
      "maxSize": 1000000,
      "type": "blob"
    },
    "title": {
      "type": "string"
    },
    "uri": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "title",
    "description"
  ],
  "type": "object"
}
view object

No description available.

Properties

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

No description available.

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Required

No description available.

image string uri Optional

A valid URI.

likeCount integer Optional

No description available.

minimum: 0
readingTime integer Optional

No description available.

minimum: 1
title string Required

No description available.

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string uri Required

A valid URI.

View raw schema
{
  "properties": {
    "associatedProfiles": {
      "items": {
        "ref": "app.bsky.actor.defs#profileViewBasic",
        "type": "ref"
      },
      "type": "array"
    },
    "associatedRefs": {
      "items": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref"
      },
      "type": "array"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "image": {
      "format": "uri",
      "type": "string"
    },
    "labels": {
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "likeCount": {
      "minimum": 0,
      "type": "integer"
    },
    "likers": {
      "description": "Available profile previews. Selected deterministically by DID; not a ranking.",
      "items": {
        "ref": "app.bsky.actor.defs#profileViewBasic",
        "type": "ref"
      },
      "maxLength": 3,
      "type": "array"
    },
    "publisher": {
      "ref": "#viewArticlePublication",
      "type": "ref"
    },
    "readingTime": {
      "minimum": 1,
      "type": "integer"
    },
    "title": {
      "type": "string"
    },
    "updatedAt": {
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "title",
    "description"
  ],
  "type": "object"
}
viewArticlePublication object

No description available.

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Required

No description available.

image string uri Optional

A valid URI.

subscriptionCount integer Optional

No description available.

minimum: 0
title string Required

No description available.

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string uri Required

A valid URI.

View raw schema
{
  "properties": {
    "associatedProfiles": {
      "items": {
        "ref": "app.bsky.actor.defs#profileViewBasic",
        "type": "ref"
      },
      "type": "array"
    },
    "associatedRefs": {
      "items": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref"
      },
      "type": "array"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "image": {
      "format": "uri",
      "type": "string"
    },
    "labels": {
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "logo": {
      "format": "uri",
      "type": "string"
    },
    "subscribers": {
      "description": "Available profile previews. Selected deterministically by DID; not a ranking.",
      "items": {
        "ref": "app.bsky.actor.defs#profileViewBasic",
        "type": "ref"
      },
      "maxLength": 3,
      "type": "array"
    },
    "subscriptionCount": {
      "minimum": 0,
      "type": "integer"
    },
    "theme": {
      "ref": "#viewArticlePublicationTheme",
      "type": "ref"
    },
    "title": {
      "type": "string"
    },
    "updatedAt": {
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "title",
    "description"
  ],
  "type": "object"
}
viewArticlePublicationTheme object

No description available.

Properties

accent string Optional

Hex color string, if available. Example: '#ffffff'.

accentForeground string Optional

Hex color string, if available. Example: '#ffffff'.

background string Optional

Hex color string, if available. Example: '#ffffff'.

foreground string Optional

Hex color string, if available. Example: '#ffffff'.

View raw schema
{
  "properties": {
    "accent": {
      "description": "Hex color string, if available. Example: '#ffffff'.",
      "type": "string"
    },
    "accentForeground": {
      "description": "Hex color string, if available. Example: '#ffffff'.",
      "type": "string"
    },
    "background": {
      "description": "Hex color string, if available. Example: '#ffffff'.",
      "type": "string"
    },
    "foreground": {
      "description": "Hex color string, if available. Example: '#ffffff'.",
      "type": "string"
    }
  },
  "type": "object"
}
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
{
  "properties": {
    "associatedProfiles": {
      "description": "Profiles of the owners of the Atmosphere records that backed this view.",
      "items": {
        "ref": "app.bsky.actor.defs#profileViewBasic",
        "type": "ref"
      },
      "type": "array"
    },
    "associatedRefs": {
      "description": "StrongRefs (uri+cid) of the Atmosphere records that backed this view.",
      "items": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref"
      },
      "type": "array"
    },
    "createdAt": {
      "description": "When the external content was created, if available. Example: a publication date, for an article.",
      "format": "datetime",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "labels": {
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "readingTime": {
      "description": "Estimated reading time in minutes, if applicable and available.",
      "type": "integer"
    },
    "source": {
      "ref": "#viewExternalSource",
      "type": "ref"
    },
    "thumb": {
      "format": "uri",
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "updatedAt": {
      "description": "When the external content was updated, if available.",
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "title",
    "description"
  ],
  "type": "object"
}
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
{
  "description": "The source of an external embed, such as a standard.site publication.",
  "properties": {
    "description": {
      "type": "string"
    },
    "icon": {
      "description": "Fully-qualified URL where an icon representing the source can be fetched. For example, CDN location provided by the App View.",
      "format": "uri",
      "type": "string"
    },
    "theme": {
      "ref": "#viewExternalSourceTheme",
      "type": "ref"
    },
    "title": {
      "type": "string"
    },
    "uri": {
      "description": "URI of the source, if available. Example: the https:// URL of a site.standard.publication record.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "title"
  ],
  "type": "object"
}
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
{
  "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.",
  "properties": {
    "accentForegroundRGB": {
      "ref": "#colorRGB",
      "type": "ref"
    },
    "accentRGB": {
      "ref": "#colorRGB",
      "type": "ref"
    },
    "backgroundRGB": {
      "ref": "#colorRGB",
      "type": "ref"
    },
    "foregroundRGB": {
      "ref": "#colorRGB",
      "type": "ref"
    }
  },
  "type": "object"
}
viewGallery object

No description available.

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Required

No description available.

items array of union Required

The media items in the gallery. Each item may be of a different type, but all types must be supported by the client.

Known types:
likeCount integer Optional

No description available.

minimum: 0
title string Required

No description available.

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string uri Required

A valid URI.

View raw schema
{
  "properties": {
    "associatedProfiles": {
      "items": {
        "ref": "app.bsky.actor.defs#profileViewBasic",
        "type": "ref"
      },
      "type": "array"
    },
    "associatedRefs": {
      "items": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref"
      },
      "type": "array"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "items": {
      "description": "The media items in the gallery. Each item may be of a different type, but all types must be supported by the client.",
      "items": {
        "refs": [
          "#viewGalleryImage"
        ],
        "type": "union"
      },
      "type": "array"
    },
    "labels": {
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "likeCount": {
      "minimum": 0,
      "type": "integer"
    },
    "likers": {
      "description": "Available profile previews. Selected deterministically by DID; not a ranking.",
      "items": {
        "ref": "app.bsky.actor.defs#profileViewBasic",
        "type": "ref"
      },
      "maxLength": 3,
      "type": "array"
    },
    "title": {
      "type": "string"
    },
    "updatedAt": {
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "title",
    "description",
    "items"
  ],
  "type": "object"
}
viewGalleryImage object

No description available.

Properties

alt string Optional

Alt text description of the image, for accessibility.

fullsize string uri Required

Fully-qualified URL where a large version of the image can be fetched. May or may not be the exact original blob. For example, CDN location provided by the App View.

thumbnail string uri Required

Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View.

View raw schema
{
  "properties": {
    "alt": {
      "description": "Alt text description of the image, for accessibility.",
      "type": "string"
    },
    "aspectRatio": {
      "ref": "app.bsky.embed.defs#aspectRatio",
      "type": "ref"
    },
    "fullsize": {
      "description": "Fully-qualified URL where a large version of the image can be fetched. May or may not be the exact original blob. For example, CDN location provided by the App View.",
      "format": "uri",
      "type": "string"
    },
    "thumbnail": {
      "description": "Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "thumbnail",
    "fullsize"
  ],
  "type": "object"
}
viewLivestream object

No description available.

Properties

active boolean Required

True if the livestream is currently active at the time this view is served, false if it has ended.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Required

No description available.

endedAt string datetime Optional

An RFC 3339 formatted timestamp.

image string uri Optional

A valid URI.

startedAt string datetime Optional

An RFC 3339 formatted timestamp.

title string Required

No description available.

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

uri string uri Required

A valid URI.

View raw schema
{
  "properties": {
    "active": {
      "description": "True if the livestream is currently active at the time this view is served, false if it has ended.",
      "type": "boolean"
    },
    "associatedProfiles": {
      "items": {
        "ref": "app.bsky.actor.defs#profileViewBasic",
        "type": "ref"
      },
      "type": "array"
    },
    "associatedRefs": {
      "items": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref"
      },
      "type": "array"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "endedAt": {
      "format": "datetime",
      "type": "string"
    },
    "image": {
      "format": "uri",
      "type": "string"
    },
    "labels": {
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      },
      "type": "array"
    },
    "startedAt": {
      "format": "datetime",
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "updatedAt": {
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "title",
    "description",
    "active"
  ],
  "type": "object"
}

Lexicon Garden

@