Sign in

v1

latestOpenAPI 3.0.2GNU AGPLv32026-07-245983524.8 KB
Term

Terms

A Term is a shared title node. It can be referenced and used by many different Index nodes. Terms that use the same TermScheme can be ordered within that scheme. So for example, Parsha terms who all share the TermScheme of parsha, can be ordered within that scheme.

Examples of valid terms: Noah, HaChovel

get/api/terms/{name}

Response

The response to a query for a specific Term in the Terms API.

namestring required

The name of the Term. Since a Term is a shared title node that can be referenced and used by many different Index nodes, the name field is critical as it contains the shared title.

schemestring

A shared scheme for a group of terms.

orderinteger

Terms that share a scheme can be ordered within that scheme. So for example, Parshiyot within the Parasha scheme can be ordered as per the order of the Parshiyot.

refstring

A string representing a citation to a Jewish text.

A valid Ref consists of a title string followed optionally by a section string or a segment string.

A title string is any one of the known text titles or title variants in the Sefaria Database.

categorystring

The category of a specific term.

Example response

{
  "name": "Noach",
  "titles": [
    {
      "primary": true,
      "text": "Noach",
      "lang": "en"
    },
    {
      "primary": true,
      "text": "נח",
      "lang": "he"
    },
    {
      "text": "Parashat Noach",
      "lang": "en"
    },
    {
      "text": "פרשת נח",
      "lang": "he"
    },
    {
      "text": "Noah",
      "lang": "en"
    },
    {
      "text": "Parshat Noah",
      "lang": "en"
    }
  ],
  "scheme": "Parasha",
  "order": 2,
  "ref": "Genesis 6:9-11:32",
  "category": "Torah Portions"
}