Webpage

  • favicon
    required
    • url
      Type: string
      required
    • height
      Type: number | null
    • mime
      Type: string | null
    • width
      Type: number | null
  • html
    required
    • url
      Type: string
      required
    • mime
      Type: string | null
    • size
      Type: number | null
  • image
    required
    • url
      Type: string
      required
    • height
      Type: number | null
    • mime
      Type: string | null
    • width
      Type: number | null
  • reader
    required
    • url
      Type: string
      required
    • mime
      Type: string | null
    • size
      Type: number | null
  • screenshot
    required
    • url
      Type: string
      required
    • height
      Type: number | null
    • mime
      Type: string | null
    • width
      Type: number | null
  • description
    Type: string | null

    Description of the link preview

  • metadata

    Metadata for special links

    • propertyName
      Type: anything nullable
  • siteName
    Type: string | null

    Site name of the link preview

  • status
    Type: string | null ยท ProcessingStateenum

    Status of the link preview

    values
    • pending
    • processing
    • completed
    • failed
  • title
    Type: string | null

    Title of the link preview

  • url
    Type: string | null

    URL of the link preview