Neynar · Schema

OembedPhotoData

Photo OEmbed data

FarcasterSocialDecentralizedWeb3BlockchainSocial GraphCastsChannelsFeedsReactionsNotificationsWebhooksOnchain

Properties

Name Type Description
author_name string The name of the author/owner of the resource.
author_url string A URL for the author/owner of the resource.
cache_age string The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.
height number The height in pixels of the image specified in the url parameter.
provider_name string The name of the resource provider.
provider_url string The url of the resource provider.
thumbnail_height number The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.
thumbnail_url string A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be
thumbnail_width number The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.
title string A text title, describing the resource.
type string
url string The source URL of the image. Consumers should be able to insert this URL into an element. Only HTTP and HTTPS URLs are valid.
version string
width number The width in pixels of the image specified in the url parameter.
View JSON Schema on GitHub

JSON Schema

oembedphotodata.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://neynar.com/schemas/OembedPhotoData",
  "title": "OembedPhotoData",
  "description": "Photo OEmbed data",
  "properties": {
    "author_name": {
      "description": "The name of the author/owner of the resource.",
      "nullable": true,
      "type": "string"
    },
    "author_url": {
      "description": "A URL for the author/owner of the resource.",
      "nullable": true,
      "type": "string"
    },
    "cache_age": {
      "description": "The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.",
      "nullable": true,
      "type": "string"
    },
    "height": {
      "description": "The height in pixels of the image specified in the url parameter.",
      "nullable": true,
      "type": "number"
    },
    "provider_name": {
      "description": "The name of the resource provider.",
      "nullable": true,
      "type": "string"
    },
    "provider_url": {
      "description": "The url of the resource provider.",
      "nullable": true,
      "type": "string"
    },
    "thumbnail_height": {
      "description": "The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.",
      "nullable": true,
      "type": "number"
    },
    "thumbnail_url": {
      "description": "A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present.",
      "nullable": true,
      "type": "string"
    },
    "thumbnail_width": {
      "description": "The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.",
      "nullable": true,
      "type": "number"
    },
    "title": {
      "description": "A text title, describing the resource.",
      "nullable": true,
      "type": "string"
    },
    "type": {
      "enum": [
        "photo"
      ],
      "type": "string"
    },
    "url": {
      "description": "The source URL of the image. Consumers should be able to insert this URL into an <img> element. Only HTTP and HTTPS URLs are valid.",
      "nullable": true,
      "type": "string"
    },
    "version": {
      "nullable": true,
      "type": "string"
    },
    "width": {
      "description": "The width in pixels of the image specified in the url parameter.",
      "nullable": true,
      "type": "number"
    }
  },
  "required": [
    "type",
    "version",
    "url"
  ],
  "type": "object"
}