Brand assets

Endpoints

• POSTUpload a brand asset/v1/brand_assets
• GETRetrieve a brand asset/v1/brand_assets/{id}
• GETDownload a brand asset/v1/brand_assets/{id}/content

The BrandAsset object

• idstringrequired

  The brand asset's ID, starting bas_.

• objectstringrequired

  Always brand_asset.

• kindstringrequired

  logo, image (a page photo) or icon (the browser tab's icon).

  One of logo image icon
• content_typestringrequired

  What is served — a logo's or an icon's PNG, a photo's WebP.

  One of image/png image/webp
• source_typestringrequired

  What was uploaded (a logo's is kept, never served; a photo's is not kept).

  One of image/png image/svg+xml image/jpeg image/webp
• sha256stringrequired

  Of the PNG (a photo's large WebP).

• widthintegerrequired

  A logo: CSS pixels (the PNG is 3× this). A photo: pixels of the large rendition. An icon: 180.

• heightintegerrequired

  A logo: CSS pixels. A photo: pixels of the large rendition. An icon: 180.

• urlstringrequired

  The path of the image itself, /v1/brand_assets/{id}/content: a logo's or an icon's PNG, or a photo's large WebP. Fetch it with your API key, like any other request.

• created_atstring · date-timerequired

  When the asset was uploaded, in ISO 8601 (UTC).

• smallobject

  A photo: the small rendition, about 800 pixels wide. An icon: the 32 pixel PNG.

  3 fields of small

  • small.urlstring
  • small.widthinteger
  • small.heightinteger
• transparent_backgroundboolean · nullable

  A logo only: whether most of its outer edge is transparent. null for a photo or an icon.