API Reference
Sefaria LibraryVoices at SefariaDevelopersMore from Sefaria ›

Social Media Image

get
https://www.sefaria.org/api/img-gen/

Given a Sefaria text Ref 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Defaults to Esther 1.1

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

Query Params
string
enum
Defaults to en

The language the social image should return, en for English language or he for Hebrew. Defaults to en if omitted. bi is accepted and returns English.

Allowed:
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:
string

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

string

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

Response

Updated 29 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 29 days ago