API Reference
Sefaria LibraryVoices at SefariaDevelopersMore from Sefaria ›
Start typing to search…

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.

Path Params
string
required
Defaults to Esther 1.1

A valid Sefaria textual Ref.

Query Params
string
enum

The language the social image should return, en for English language or he for Hebrew.

Allowed:
string
enum

This value determines the size of the image, set to the platform's ideal as specified in its own developer documentation.

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 7 months ago

Language
Response 
Click Try It! to start a request and see the response here!
Updated 7 months ago