Core

Reference for core page fields.

`version`

Name
version
Type
number
Description
Version of the page. Currently, v1 is the only available version.

{ "version": 1 }

`format`

Name
format
Type
string
Description
Set the format for the page. Currently, only 'profile' and 'article' are available.

{ "format": "profile" || "article" }

`design`

Name
design
Type
object
Description
Optional design object for page styling.

{
  "design": {
    "theme": string,
    "animation": string
  }
}

Name
theme
Type
string
Description
Set the theme of the page. Check the 'THEMES' tab on any existing lens page to find a theme. Use lowercase letters. The 'dark' theme is default.

{ "theme": "dark" }

Name
animation
Type
string
Description
Set the animation for the page. This only works for profiles. Currently, 'stars' is the only animation available.

{ "animation": "stars" }

`metadata`

Name
metadata
Type
object
Description
The metadata object containing title and description fields.

{
  "metadata": {
    "title": string,
    "description": string
  }
}

Name
title
Type
string
Description
The title tag for a page.

{ "title": "Page Title" }

Name
description
Type
string
Description
The meta description tag for a page.

{ "description": "Page meta description" }

`components`

Name
components
Type
object
Description
Components object containing the header and blocks objects.

{
  "components": {
    "header": object,
    "blocks": array
  }
}