betterimage.io

Make a social card for a page that already exists, in one call: fetches the page like a crawler, takes its title, description, author, domain and site icon, picks the starter design that fits the page (a Jev decision over every preset, about 100 ms) and returns the image (shown inline, watermarked, free). Use this first when the user gives a URL: "make an OG image for my latest post". Any field you pass overrides what the page says. Pass preset (see list_presets) to choose the design yourself, or a size. No API key needed; one page fetch plus one render per call.

{
  "type": "object",
  "properties": {
    "fields": {
      "type": "object",
      "description": "What to put on the card. Text fields replace the template's text; the *_url fields replace its pictures, fetched server-side. Omit a field to keep what the template has. Design - colours, fonts, layout, crop framing - never changes.",
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string",
          "description": "Byline (up to 50 characters). The handle on Profile, the reviewer's name on Testimonial."
        },
        "background_url": {
          "type": "string",
          "description": "Absolute https URL of the background photo, on a template whose background is a photo. Works on every card kind."
        },
        "badge": {
          "type": "string",
          "description": "Sale sticker in a corner of the card, Product cards only: \"-30%\", \"SALE\", \"2 FOR 1\" (up to 18 characters)."
        },
        "description": {
          "type": "string",
          "description": "Support line under the headline (up to 220 characters). The bio on Profile, the quote on Testimonial. Not drawn by Minimal templates."
        },
        "footer": {
          "type": "string",
          "description": "Tagline in the corner, typically the domain (up to 60 characters)."
        },
        "image2_url": {
          "type": "string",
          "description": "Absolute https URL of the second capture, used only by the Product card's window-and-phone frame (the phone over the browser window's corner). It needs image_url too: on its own there is no window for the phone to sit over and nothing is drawn."
        },
        "image_url": {
          "type": "string",
          "description": "Absolute https URL of the picture for the card's image slot - the product photo, the screenshot inside the frame, or the avatar on a Profile card. PNG, JPEG or WebP, up to 5 MB. Omit it to keep the template's own picture. Minimal cards have no image slot."
        },
        "logo_url": {
          "type": "string",
          "description": "Absolute https URL of the corner logo, pinned above the text. Drawn by every card kind except Profile, whose own picture is the avatar."
        },
        "price": {
          "type": "string",
          "description": "Price headline under the pitch, Product cards only. Free text so it can read \"$29\", \"49 PLN\" or \"Free\" (up to 16 characters)."
        },
        "price_note": {
          "type": "string",
          "description": "Small print beside the price, Product cards only: a billing period, a former price or a shipping note (up to 40 characters)."
        },
        "price_was": {
          "type": "string",
          "description": "The price this one replaces, drawn struck through beside it, Product cards only (up to 16 characters)."
        },
        "rating": {
          "maximum": 5,
          "type": "integer",
          "description": "Star rating, Testimonial and Product cards only.",
          "minimum": 1
        },
        "tag": {
          "type": "string",
          "description": "Short label above the headline, e.g. \"NEW POST\" (up to 30 characters). The company on Testimonial."
        },
        "title": {
          "type": "string",
          "description": "Headline. Up to 220 characters; long titles auto-shrink to fit. On Profile cards this is the person's name, on Testimonial cards the role, on Product cards the product's name."
        }
      }
    },
    "preset": {
      "type": "string",
      "description": "Preset key from list_presets. Omit it to let Jev pick the design that fits the page (the result names the pick and its runners-up). Fallback when no pick is possible: og-essay-light."
    },
    "size": {
      "type": "string",
      "enum": [
        "og",
        "youtube",
        "square",
        "portrait",
        "story",
        "pinterest"
      ],
      "description": "Output canvas: og (1200x630), youtube (1280x720), square (1080x1080), portrait (1080x1350), story (1080x1920), pinterest (1000x1500). Defaults to the template's own size, usually og (1200x630, the link preview size). Layouts restack automatically on square and vertical canvases."
    },
    "url": {
      "type": "string",
      "description": "The page URL, e.g. https://example.com/blog/my-post."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Browse the ready-made designs (presets) a card can start from: key, name, template kind, native size, use-case categories, a one-line look description and a preview image URL. Start here when the user wants a social card and has no saved template. Then call preview_card with the chosen key. No API key needed.

{
  "type": "object",
  "properties": {
    "category": {
      "type": "string",
      "enum": [
        "blog-post",
        "announcement",
        "quote",
        "testimonial",
        "event",
        "podcast",
        "hiring",
        "product",
        "changelog",
        "newsletter",
        "profile",
        "sale",
        "stats",
        "course",
        "youtube-thumbnail",
        "instagram-post",
        "pinterest-pin",
        "story"
      ],
      "description": "Only presets in this use-case or format category."
    },
    "kind": {
      "type": "string",
      "enum": [
        "basic",
        "profile",
        "testimonial",
        "minimal",
        "product"
      ],
      "description": "Only this template kind. basic: headline + photo cards. profile: photo, name, role. testimonial: quote with reviewer and rating. minimal: headline-only. product: framed screenshot with a rating and a price."
    },
    "query": {
      "type": "string",
      "description": "Case-insensitive match against the preset's name, key and look description, e.g. \"dark\", \"serif\", \"pastel\"."
    }
  },
  "additionalProperties": false
}

Render a preset with the user's text and return the image (shown inline). Free, no API key; the preview carries a small betterimage.io watermark and does not touch any quota. Use it to show the user what their card will look like before they commit. For a clean image: save_template + render_card on a paid API plan, or the one-off clean download in the editor.

{
  "type": "object",
  "properties": {
    "fields": {
      "type": "object",
      "description": "What to put on the card. Text fields replace the template's text; the *_url fields replace its pictures, fetched server-side. Omit a field to keep what the template has. Design - colours, fonts, layout, crop framing - never changes.",
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string",
          "description": "Byline (up to 50 characters). The handle on Profile, the reviewer's name on Testimonial."
        },
        "background_url": {
          "type": "string",
          "description": "Absolute https URL of the background photo, on a template whose background is a photo. Works on every card kind."
        },
        "badge": {
          "type": "string",
          "description": "Sale sticker in a corner of the card, Product cards only: \"-30%\", \"SALE\", \"2 FOR 1\" (up to 18 characters)."
        },
        "description": {
          "type": "string",
          "description": "Support line under the headline (up to 220 characters). The bio on Profile, the quote on Testimonial. Not drawn by Minimal templates."
        },
        "footer": {
          "type": "string",
          "description": "Tagline in the corner, typically the domain (up to 60 characters)."
        },
        "image2_url": {
          "type": "string",
          "description": "Absolute https URL of the second capture, used only by the Product card's window-and-phone frame (the phone over the browser window's corner). It needs image_url too: on its own there is no window for the phone to sit over and nothing is drawn."
        },
        "image_url": {
          "type": "string",
          "description": "Absolute https URL of the picture for the card's image slot - the product photo, the screenshot inside the frame, or the avatar on a Profile card. PNG, JPEG or WebP, up to 5 MB. Omit it to keep the template's own picture. Minimal cards have no image slot."
        },
        "logo_url": {
          "type": "string",
          "description": "Absolute https URL of the corner logo, pinned above the text. Drawn by every card kind except Profile, whose own picture is the avatar."
        },
        "price": {
          "type": "string",
          "description": "Price headline under the pitch, Product cards only. Free text so it can read \"$29\", \"49 PLN\" or \"Free\" (up to 16 characters)."
        },
        "price_note": {
          "type": "string",
          "description": "Small print beside the price, Product cards only: a billing period, a former price or a shipping note (up to 40 characters)."
        },
        "price_was": {
          "type": "string",
          "description": "The price this one replaces, drawn struck through beside it, Product cards only (up to 16 characters)."
        },
        "rating": {
          "maximum": 5,
          "type": "integer",
          "description": "Star rating, Testimonial and Product cards only.",
          "minimum": 1
        },
        "tag": {
          "type": "string",
          "description": "Short label above the headline, e.g. \"NEW POST\" (up to 30 characters). The company on Testimonial."
        },
        "title": {
          "type": "string",
          "description": "Headline. Up to 220 characters; long titles auto-shrink to fit. On Profile cards this is the person's name, on Testimonial cards the role, on Product cards the product's name."
        }
      }
    },
    "preset": {
      "type": "string",
      "description": "Preset key from list_presets, e.g. \"loud-pastel\"."
    },
    "size": {
      "type": "string",
      "enum": [
        "og",
        "youtube",
        "square",
        "portrait",
        "story",
        "pinterest"
      ],
      "description": "Output canvas: og (1200x630), youtube (1280x720), square (1080x1080), portrait (1080x1350), story (1080x1920), pinterest (1000x1500). Defaults to the template's own size, usually og (1200x630, the link preview size). Layouts restack automatically on square and vertical canvases."
    }
  },
  "required": [
    "preset"
  ],
  "additionalProperties": false
}

Fetch a public page the way X, Facebook, LinkedIn, Slack and Discord crawlers do and report what they will show: the effective title, description and image per platform, the og:image's real format, dimensions and weight, and a list of concrete problems with fixes. Use when a user asks why their link looks wrong when shared, or before publishing. Only http(s) URLs on the public internet; one page fetch plus up to two image fetches per call. No API key needed.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The page URL, e.g. https://example.com/post."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Build the complete <head> block for a page: <title>, meta description, canonical, Open Graph and Twitter card tags, with og:image width/height. Returns HTML to paste plus notes on anything worth fixing (title too long, image over http). Use after check_link_preview, or whenever a user needs the tags for a new page. No API key needed; nothing is fetched.

{
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "One or two sentences (aim for 160 characters or fewer)."
    },
    "image_alt": {
      "type": "string",
      "description": "Alt text for the image."
    },
    "image_height": {
      "type": "integer",
      "description": "Pixel height of the image file. Default 630."
    },
    "image_url": {
      "type": "string",
      "description": "Absolute https URL of the share image. A signed URL from og_image_url, or a PNG from render_card that you host."
    },
    "image_width": {
      "type": "integer",
      "description": "Pixel width of the image file. Default 1200."
    },
    "site_name": {
      "type": "string",
      "description": "Site or brand name for og:site_name."
    },
    "title": {
      "type": "string",
      "description": "Page title (aim for 60 characters or fewer)."
    },
    "twitter_card": {
      "type": "string",
      "enum": [
        "summary_large_image",
        "summary"
      ],
      "description": "Twitter card layout. summary_large_image (default) shows the big image."
    },
    "type": {
      "type": "string",
      "enum": [
        "website",
        "article"
      ],
      "description": "og:type. Default website."
    },
    "url": {
      "type": "string",
      "description": "Canonical page URL."
    }
  },
  "required": [
    "title"
  ],
  "additionalProperties": false
}

The user's saved templates (their own designs, made in the editor or with save_template): slug, name, kind, the fields render_card and og_image_url can override, and when it was last edited. Needs an API key. Call this before render_card or og_image_url when you do not know the slug.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Copy a preset (optionally with the user's text as its new defaults) into the user's account as a saved template, so render_card and og_image_url can use it. Needs an API key. Do this once per design, not per image: afterwards every render only passes the text that changes. Returns the slug to use next and a link to fine-tune the design in the editor.

{
  "type": "object",
  "properties": {
    "fields": {
      "type": "object",
      "description": "What to put on the card. Text fields replace the template's text; the *_url fields replace its pictures, fetched server-side. Omit a field to keep what the template has. Design - colours, fonts, layout, crop framing - never changes.",
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string",
          "description": "Byline (up to 50 characters). The handle on Profile, the reviewer's name on Testimonial."
        },
        "background_url": {
          "type": "string",
          "description": "Absolute https URL of the background photo, on a template whose background is a photo. Works on every card kind."
        },
        "badge": {
          "type": "string",
          "description": "Sale sticker in a corner of the card, Product cards only: \"-30%\", \"SALE\", \"2 FOR 1\" (up to 18 characters)."
        },
        "description": {
          "type": "string",
          "description": "Support line under the headline (up to 220 characters). The bio on Profile, the quote on Testimonial. Not drawn by Minimal templates."
        },
        "footer": {
          "type": "string",
          "description": "Tagline in the corner, typically the domain (up to 60 characters)."
        },
        "image2_url": {
          "type": "string",
          "description": "Absolute https URL of the second capture, used only by the Product card's window-and-phone frame (the phone over the browser window's corner). It needs image_url too: on its own there is no window for the phone to sit over and nothing is drawn."
        },
        "image_url": {
          "type": "string",
          "description": "Absolute https URL of the picture for the card's image slot - the product photo, the screenshot inside the frame, or the avatar on a Profile card. PNG, JPEG or WebP, up to 5 MB. Omit it to keep the template's own picture. Minimal cards have no image slot."
        },
        "logo_url": {
          "type": "string",
          "description": "Absolute https URL of the corner logo, pinned above the text. Drawn by every card kind except Profile, whose own picture is the avatar."
        },
        "price": {
          "type": "string",
          "description": "Price headline under the pitch, Product cards only. Free text so it can read \"$29\", \"49 PLN\" or \"Free\" (up to 16 characters)."
        },
        "price_note": {
          "type": "string",
          "description": "Small print beside the price, Product cards only: a billing period, a former price or a shipping note (up to 40 characters)."
        },
        "price_was": {
          "type": "string",
          "description": "The price this one replaces, drawn struck through beside it, Product cards only (up to 16 characters)."
        },
        "rating": {
          "maximum": 5,
          "type": "integer",
          "description": "Star rating, Testimonial and Product cards only.",
          "minimum": 1
        },
        "tag": {
          "type": "string",
          "description": "Short label above the headline, e.g. \"NEW POST\" (up to 30 characters). The company on Testimonial."
        },
        "title": {
          "type": "string",
          "description": "Headline. Up to 220 characters; long titles auto-shrink to fit. On Profile cards this is the person's name, on Testimonial cards the role, on Product cards the product's name."
        }
      }
    },
    "name": {
      "type": "string",
      "description": "Template name (up to 80 characters); its slug is derived from it. Defaults to the preset's name."
    },
    "preset": {
      "type": "string",
      "description": "Preset key from list_presets."
    },
    "size": {
      "type": "string",
      "enum": [
        "og",
        "youtube",
        "square",
        "portrait",
        "story",
        "pinterest"
      ],
      "description": "Output canvas: og (1200x630), youtube (1280x720), square (1080x1080), portrait (1080x1350), story (1080x1920), pinterest (1000x1500). Defaults to the template's own size, usually og (1200x630, the link preview size). Layouts restack automatically on square and vertical canvases."
    }
  },
  "required": [
    "preset"
  ],
  "additionalProperties": false
}

Render one of the user's saved templates with the given text and return the PNG (shown inline, at 1x). Needs an API key. On a paid plan the image is clean (no watermark); on the free tier it is watermarked. Each call spends one image of the monthly quota. Use it when the user wants the actual file, e.g. to host it themselves. For an og:image tag that needs no hosting, or for a 2x retina file, prefer og_image_url.

{
  "type": "object",
  "properties": {
    "fields": {
      "type": "object",
      "description": "What to put on the card. Text fields replace the template's text; the *_url fields replace its pictures, fetched server-side. Omit a field to keep what the template has. Design - colours, fonts, layout, crop framing - never changes.",
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string",
          "description": "Byline (up to 50 characters). The handle on Profile, the reviewer's name on Testimonial."
        },
        "background_url": {
          "type": "string",
          "description": "Absolute https URL of the background photo, on a template whose background is a photo. Works on every card kind."
        },
        "badge": {
          "type": "string",
          "description": "Sale sticker in a corner of the card, Product cards only: \"-30%\", \"SALE\", \"2 FOR 1\" (up to 18 characters)."
        },
        "description": {
          "type": "string",
          "description": "Support line under the headline (up to 220 characters). The bio on Profile, the quote on Testimonial. Not drawn by Minimal templates."
        },
        "footer": {
          "type": "string",
          "description": "Tagline in the corner, typically the domain (up to 60 characters)."
        },
        "image2_url": {
          "type": "string",
          "description": "Absolute https URL of the second capture, used only by the Product card's window-and-phone frame (the phone over the browser window's corner). It needs image_url too: on its own there is no window for the phone to sit over and nothing is drawn."
        },
        "image_url": {
          "type": "string",
          "description": "Absolute https URL of the picture for the card's image slot - the product photo, the screenshot inside the frame, or the avatar on a Profile card. PNG, JPEG or WebP, up to 5 MB. Omit it to keep the template's own picture. Minimal cards have no image slot."
        },
        "logo_url": {
          "type": "string",
          "description": "Absolute https URL of the corner logo, pinned above the text. Drawn by every card kind except Profile, whose own picture is the avatar."
        },
        "price": {
          "type": "string",
          "description": "Price headline under the pitch, Product cards only. Free text so it can read \"$29\", \"49 PLN\" or \"Free\" (up to 16 characters)."
        },
        "price_note": {
          "type": "string",
          "description": "Small print beside the price, Product cards only: a billing period, a former price or a shipping note (up to 40 characters)."
        },
        "price_was": {
          "type": "string",
          "description": "The price this one replaces, drawn struck through beside it, Product cards only (up to 16 characters)."
        },
        "rating": {
          "maximum": 5,
          "type": "integer",
          "description": "Star rating, Testimonial and Product cards only.",
          "minimum": 1
        },
        "tag": {
          "type": "string",
          "description": "Short label above the headline, e.g. \"NEW POST\" (up to 30 characters). The company on Testimonial."
        },
        "title": {
          "type": "string",
          "description": "Headline. Up to 220 characters; long titles auto-shrink to fit. On Profile cards this is the person's name, on Testimonial cards the role, on Product cards the product's name."
        }
      }
    },
    "size": {
      "type": "string",
      "enum": [
        "og",
        "youtube",
        "square",
        "portrait",
        "story",
        "pinterest"
      ],
      "description": "Output canvas: og (1200x630), youtube (1280x720), square (1080x1080), portrait (1080x1350), story (1080x1920), pinterest (1000x1500). Defaults to the template's own size, usually og (1200x630, the link preview size). Layouts restack automatically on square and vertical canvases."
    },
    "template": {
      "type": "string",
      "description": "Template slug from list_templates or save_template."
    }
  },
  "required": [
    "template"
  ],
  "additionalProperties": false
}

Build a signed image URL for a saved template with the given text, ready to put in a page's <meta property="og:image"> tag. Nothing is rendered now: the image is generated when a crawler fetches the URL, cached at the edge for a day, and each uncached fetch spends one image of the monthly quota. Needs an API key. This is the zero-infrastructure way to give every page its own card; use it in page templates, CMS hooks and static site generators. Returns the URL and the ready meta tag.

{
  "type": "object",
  "properties": {
    "fields": {
      "type": "object",
      "description": "What to put on the card. Text fields replace the template's text; the *_url fields replace its pictures, fetched server-side. Omit a field to keep what the template has. Design - colours, fonts, layout, crop framing - never changes.",
      "additionalProperties": false,
      "properties": {
        "author": {
          "type": "string",
          "description": "Byline (up to 50 characters). The handle on Profile, the reviewer's name on Testimonial."
        },
        "background_url": {
          "type": "string",
          "description": "Absolute https URL of the background photo, on a template whose background is a photo. Works on every card kind."
        },
        "badge": {
          "type": "string",
          "description": "Sale sticker in a corner of the card, Product cards only: \"-30%\", \"SALE\", \"2 FOR 1\" (up to 18 characters)."
        },
        "description": {
          "type": "string",
          "description": "Support line under the headline (up to 220 characters). The bio on Profile, the quote on Testimonial. Not drawn by Minimal templates."
        },
        "footer": {
          "type": "string",
          "description": "Tagline in the corner, typically the domain (up to 60 characters)."
        },
        "image2_url": {
          "type": "string",
          "description": "Absolute https URL of the second capture, used only by the Product card's window-and-phone frame (the phone over the browser window's corner). It needs image_url too: on its own there is no window for the phone to sit over and nothing is drawn."
        },
        "image_url": {
          "type": "string",
          "description": "Absolute https URL of the picture for the card's image slot - the product photo, the screenshot inside the frame, or the avatar on a Profile card. PNG, JPEG or WebP, up to 5 MB. Omit it to keep the template's own picture. Minimal cards have no image slot."
        },
        "logo_url": {
          "type": "string",
          "description": "Absolute https URL of the corner logo, pinned above the text. Drawn by every card kind except Profile, whose own picture is the avatar."
        },
        "price": {
          "type": "string",
          "description": "Price headline under the pitch, Product cards only. Free text so it can read \"$29\", \"49 PLN\" or \"Free\" (up to 16 characters)."
        },
        "price_note": {
          "type": "string",
          "description": "Small print beside the price, Product cards only: a billing period, a former price or a shipping note (up to 40 characters)."
        },
        "price_was": {
          "type": "string",
          "description": "The price this one replaces, drawn struck through beside it, Product cards only (up to 16 characters)."
        },
        "rating": {
          "maximum": 5,
          "type": "integer",
          "description": "Star rating, Testimonial and Product cards only.",
          "minimum": 1
        },
        "tag": {
          "type": "string",
          "description": "Short label above the headline, e.g. \"NEW POST\" (up to 30 characters). The company on Testimonial."
        },
        "title": {
          "type": "string",
          "description": "Headline. Up to 220 characters; long titles auto-shrink to fit. On Profile cards this is the person's name, on Testimonial cards the role, on Product cards the product's name."
        }
      }
    },
    "scale": {
      "type": "integer",
      "enum": [
        1,
        2
      ],
      "description": "2 renders at twice the pixel size for high-DPI screens (a 1200x630 card becomes 2400x1260). Default 1."
    },
    "size": {
      "type": "string",
      "enum": [
        "og",
        "youtube",
        "square",
        "portrait",
        "story",
        "pinterest"
      ],
      "description": "Output canvas: og (1200x630), youtube (1280x720), square (1080x1080), portrait (1080x1350), story (1080x1920), pinterest (1000x1500). Defaults to the template's own size, usually og (1200x630, the link preview size). Layouts restack automatically on square and vertical canvases."
    },
    "template": {
      "type": "string",
      "description": "Template slug from list_templates or save_template."
    }
  },
  "required": [
    "template"
  ],
  "additionalProperties": false
}

The API key's plan, whether renders are watermarked, and this month's image quota: used, remaining, and the reset date. Needs an API key. Check it before batch renders, or when a render came back watermarked unexpectedly.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}