There are two possible forms for the string passed as the version:
language
language|versionTitle
When in the form of language, the primary version of that language is returned in the versions field of the response object. When in the form of language|versionTitle, only that specific version is returned in the versions field.
Notes:
language is the full English name of the language. In cases of dialectics with varying sub-specifities, please pass the ‘mother’ language (so for example, arabic rather than judeo-arabic). This field is NOT case sensitive.
versionTitle is the exact English versionTitle of the given version in the Sefaria database.
- When only
language is passed, the response will return a single version of the text in that language, the one that is highest priority in the Sefaria database.
- Requests can have more than one
version param. If no version was passed, the API defaults to version=primary.
Special Values
The following values can be passed in as special values to the version parameter.
source: When version=source is passed, it retrieves the text in its "source" language (i.e. the original language the text was written in, versus a translation).
translation: When version=translationis passed, it retrieves a translation of the text.
primary: When version=primary is passed, it retrieves the primary text as per the Sefaria database (i.e. the isPrimary field on the version in the database is set to True). Usually the text returned is identical to what is returned with the special value of source, but it can also include other languages (e.g. Hebrew for the Kuzari, which was originally written in Judeo-Arabic)
all: get all texts in the required language.
If a required version is missing that information will be under the field warnings of the response.