A share card

GET

/api/v1/brand/cards/{template}

curl --request GET \
  --url 'http://localhost:3000/api/v1/brand/cards/example?theme=light' \
  --header 'Authorization: Bearer <token>'

The brand’s latest release drawn as a picture: its paper, ink and accent, its logo and its faces, with the query’s words. og is a 1200x630 PNG for a page’s og:image. A public brand’s is on BrandHub too, keyless: {org}/{brand}/og.png. Its ETag names everything it is drawn from; If-None-Match answers 304 without drawing it.

Scope: read.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

template

required

string

The card: og, the 1200x630 Open Graph image

Query Parameters

title

string

Required: the card’s title, up to 140 characters

eyebrow

string

A short line above the title, up to 60 characters

subtitle

string

A line or two under the title, up to 200 characters

image

string format: uuid

An asset’s id: its picture beside the text. The release’s own, or one the caller may see

theme

string

default: light

Allowed values: light dark

The card’s ground

brand

string

A brand’s slug; the default brand without it

version

string

Live (the default): the release readers see; a number: that release

Responses

200

The card, as image/png (binary)

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}