Social Media Image

get

https://www.sefaria.org/api/img-gen/{tref}

Given a Sefaria text Ref or page path and some other optional parameters, this endpoint returns a .png image ready to share on social media. At Sefaria.org we use it primarily to auto-generate social media images for any page. If no path is provided, the endpoint returns a fallback image for the request host.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tref

string

required

Defaults to Esther 1.1

A valid Sefaria ref or page path. A Sefaria ref is a human-readable text citation, e.g. Genesis 1:1, Berakhot 2a, or Rashi on Genesis 1:1.

Query Params

lang

string

enum

Defaults to en

The language the social image should return, en for English language or he for Hebrew. Defaults to the language associated with the request host if omitted. bi is accepted but does not return a bilingual image; it uses the language associated with the request host.

Allowed:

platform

string

enum

Defaults to facebook

This value determines the size of the image, set to the platform's ideal as specified in its own developer documentation. Defaults to facebook if omitted or invalid. Use twitter for X/Twitter cards.

Allowed:

ven

string

The title of the version of English text desired for the image.

vhe

string

The title of the version of Hebrew text desired for the image.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here!

200Successful Response