Sign in

v1

latestOpenAPI 3.0.2GNU AGPLv32026-07-245983524.8 KB
Text

Returns the English and Hebrew text plus metadata such as the language, ref for the url, and so forth for many refs at once. The path parameter is a pipe-delimited list of refs.

get/api/bulktext/{refs}

Path parameters

refsstring required

Pipe-delimited list of Sefaria refs. A Sefaria ref is a human-readable text citation, e.g. Genesis 1:1, Berakhot 2a, or Rashi on Genesis 1:1. Use dots for section separators, e.g. Genesis.1.1|Exodus.1.1.

Response

Successful Response

hestring

Hebrew text for the ref. May be an empty string if no Hebrew text is available.

enstring

English text for the ref. May be an empty string if no English text is available.

langstring

Language of the ref string itself — he if the input ref was Hebrew, en otherwise.

refstring

Normalized canonical ref.

heRefstring

Hebrew form of the ref.

urlstring

URL-safe form of the ref, suitable for constructing a Sefaria link.

primary_categorystring

Top-level category of the text. Only present when useTextFamily=1 is passed.