# us.off-the-clock.bookmark.preview

> Published by [off-the-clock.us](https://lexicon.garden/identity/did:plc:tevv7zpavtjtsvqrrwwipobt)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.bookmark.preview)
- [Documentation](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.bookmark.preview/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.bookmark.preview/examples)

## Definitions

### `us.off-the-clock.bookmark.preview`

**Type**: `record`

What a bookmarked page says about itself, kept beside the bookmark by the member's own client: under the record key of its community.lexicon.bookmarks.bookmark, in the same space and repository, so a reader with either record can fetch the other. It is derived from a fetch of the page and rewritten under the same key when refreshed; a page with no usable image gets none.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `createdAt` | `string` (datetime) | Yes | When the page was fetched. |
| `description` | `string` | No | og:description, else the HTML meta description. |
| `image` | `blob` | Yes | The page's og:image (or oEmbed thumbnail), uploaded as the member's blob. |
| `imageAlt` | `string` | No | og:image:alt, when the page gives one. |
| `siteName` | `string` | No | og:site_name, else the oEmbed provider name. |
| `source` | `string` | No | Where the title and description came from. |
| `title` | `string` | No | og:title, else the oEmbed title, else the HTML title. |
| `url` | `string` (uri) | Yes | The page's final URL, after redirects; the bookmark keeps what was saved. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "What a bookmarked page says about itself, kept beside the bookmark by the member's own client: under the record key of its community.lexicon.bookmarks.bookmark, in the same space and repository, so a reader with either record can fetch the other. It is derived from a fetch of the page and rewritten under the same key when refreshed; a page with no usable image gets none.",
      "key": "tid",
      "record": {
        "properties": {
          "createdAt": {
            "description": "When the page was fetched.",
            "format": "datetime",
            "type": "string"
          },
          "description": {
            "description": "og:description, else the HTML meta description.",
            "maxGraphemes": 1000,
            "maxLength": 10000,
            "type": "string"
          },
          "image": {
            "accept": [
              "image/*"
            ],
            "description": "The page's og:image (or oEmbed thumbnail), uploaded as the member's blob.",
            "maxSize": 1000000,
            "type": "blob"
          },
          "imageAlt": {
            "description": "og:image:alt, when the page gives one.",
            "maxGraphemes": 1000,
            "maxLength": 10000,
            "type": "string"
          },
          "siteName": {
            "description": "og:site_name, else the oEmbed provider name.",
            "maxGraphemes": 200,
            "maxLength": 2000,
            "type": "string"
          },
          "source": {
            "description": "Where the title and description came from.",
            "knownValues": [
              "og",
              "oembed",
              "html"
            ],
            "maxLength": 64,
            "type": "string"
          },
          "title": {
            "description": "og:title, else the oEmbed title, else the HTML title.",
            "maxGraphemes": 300,
            "maxLength": 3000,
            "type": "string"
          },
          "url": {
            "description": "The page's final URL, after redirects; the bookmark keeps what was saved.",
            "format": "uri",
            "maxLength": 2048,
            "type": "string"
          }
        },
        "required": [
          "url",
          "image",
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    }
  },
  "id": "us.off-the-clock.bookmark.preview",
  "lexicon": 1
}
```