n8n-nodes-sefaria

{ "openapi": "3.0.0", "info": { "title": "Sefaria APIs", "description": "The Sefaria APIs allows live access to Sefaria's structured database of Jewish texts and their interconnections. It is designed to make getting up and running with a new web or mobile app as simple as possible. If you want to run your own database, please don't use this API to grab our data; instead you can download a complete dump of our data on GitHub.\nThis documentation is based on [Sefaria API Documentation on GitHub](https://github.com/Sefaria/Sefaria-Project/wiki/API-Documentation)\nNOTE - the Sheets, Topics, Lexicon, Shape, Terms and Calendar APIs have not yet been documented in this spec.", "contact": { "email": "dov@dovkatz.net" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.2" }, "servers": [{ "url": "https://www.sefaria.org", "description": "Sefaria Website (sefaria.org)" }, { "url": "https://www.sefaria.org.il", "description": "Sefaria Israel (sefaria.org.il)" }], "tags": [{ "name": "Index API", "description": "A text index in Sefaria is a schema describing the names and structure of a text." }, { "name": "Name API", "description": "Used as primarily as an \"autocompleter\", the name api takes a string and attempts to match that string against our data." }, { "name": "Links API", "description": "Returns a list of connections known for the given segment of text." }, { "name": "Text API", "description": "Retrieves the text and other metadata for the text reference string ref (Documentation on text references)." }, { "name": "Search API (v1)", "description": "For the simpler version of this API, see Search API (v2)." }, { "name": "Search API (v2)", "description": "Simpler search API than Search API (v1) which exposes the main search functionality available on the site." }], "paths": { "/api/texts/{ref}": { "get": { "tags": ["Text API"], "summary": "Retrieves the text and other metadata for the text reference string ref (Documentation on text references).", "description": "Retrieves the text and other metadata for the text reference string ref (Documentation on text references).\n\nYou can request a particular version of a text by specifying a version title and language, to the parameters lang and version. lang should be a two character language code. Spaces in version may be replaced with underscores (\"_\").\n* `context=0` may be used to suppress the default behavior of returning surrounding texts when only a single segment is requested.\n* `commentary=1` include a list of known connections to other texts along with the requested text.\n* `pad=0` will prevent default behavior of padding a ref down to a section level. Without `pad=0` requests for Genesis will be resolved to Genesis 1. With, it a request for Genesis returns the entire book.", "operationId": "getTextsByRef", "parameters": [{ "name": "ref", "in": "path", "description": "Valid Ref object (Shabbat.1a, etc)", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "Shabbat.1a" }, { "name": "commentary", "in": "query", "description": "(1 or 0) Include a list of known connections to other texts along with the requested text.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }, { "name": "context", "in": "query", "description": "(1 or 0) may be used to suppress the default behavior of returning surrounding texts when only a single segment is requested.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }, { "name": "pad", "in": "query", "description": "(1 or 0) will prevent default behavior of padding a ref down to a section level. Without pad=0 requests for Genesis will be resolved to Genesis 1. With, it a request for Genesis returns the entire book.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }], "responses": { "200": { "description": "Text and metadata for a given ref", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/texts/{ref}/{lang}": { "get": { "tags": ["Text API"], "summary": "Retrieves the text and other metadata for the text reference string ref in a specific language (See Above Definition)", "description": "See Above Definition. API Spec Format requires all parameters be required in path, so we need multiple definitions of this call.", "operationId": "getTextsByRefLang", "parameters": [{ "name": "ref", "in": "path", "description": "Valid Ref object (Shabbat.1a, etc)", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "format": "/^[a-z]{2}$/" }, "example": "Shabbat.1a" }, { "name": "lang", "in": "path", "description": "Language (en,he)", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "he" }, { "name": "commentary", "in": "query", "description": "(1 or 0) Include a list of known connections to other texts along with the requested text.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }, { "name": "context", "in": "query", "description": "(1 or 0) may be used to suppress the default behavior of returning surrounding texts when only a single segment is requested.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }, { "name": "pad", "in": "query", "description": "(1 or 0) will prevent default behavior of padding a ref down to a section level. Without pad=0 requests for Genesis will be resolved to Genesis 1. With, it a request for Genesis returns the entire book.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }], "responses": { "200": { "description": "Text and metadata for a given ref and lang", "content": { "application/json; charset=utf-8": { "schema": { "type": "object" } } } } } } }, "/api/texts/{ref}/{lang}/{version}": { "get": { "tags": ["Text API"], "summary": "Retrieves the text and other metadata for the text reference string ref in a specific language and a specific version(See Above Definition)", "description": "See Above Definition. API Spec Format requires all parameters be required in path, so we need multiple definitions of this call.", "operationId": "getTextsByRefLangVersion", "parameters": [{ "name": "ref", "in": "path", "description": "Valid Ref object (Shabbat.1a, etc)", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "format": "/^[a-z]{2}$/" }, "example": "Shabbat.1a" }, { "name": "lang", "in": "path", "description": "Language (en,he)", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "he" }, { "name": "version", "in": "path", "description": "Version", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": 1 }, { "name": "commentary", "in": "query", "description": "(1 or 0) Include a list of known connections to other texts along with the requested text.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }, { "name": "context", "in": "query", "description": "(1 or 0) may be used to suppress the default behavior of returning surrounding texts when only a single segment is requested.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }, { "name": "pad", "in": "query", "description": "(1 or 0) will prevent default behavior of padding a ref down to a section level. Without pad=0 requests for Genesis will be resolved to Genesis 1. With, it a request for Genesis returns the entire book.", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }], "responses": { "200": { "description": "Text and metadata for a given ref lang and version", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/links/{ref}": { "get": { "tags": ["Links API"], "summary": "Returns a list of connections known for the given segment of text.", "description": "Returns an array of objects with text. (you can supply with_text=0 to suppress text being returned)", "operationId": "getLinks", "parameters": [{ "name": "ref", "in": "path", "description": "Valid Ref object (Shabbat.1a, etc)", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" }, "example": "Shabbat.1a" }, { "name": "with_text", "in": "query", "description": "Include text segment from the reference in each result", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }], "responses": { "200": { "description": "List of connections for a given segment of text", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } } } } } }, "/api/name/{name}": { "get": { "tags": ["Name API"], "summary": "Returns autocomplete options based on names", "description": "Used as primarily as an \"autocompleter\", the name api takes a string and attempts to match that string against our data. \n# Some Examples #\n\n## A name ##\n<code>/name/Rashi</code>\n\nRashi is both a person and a commentator (and as such, Sefaria has many indices that start with his name). Rashi is not a valid Ref, but the suggested completions will lead to valid indices and Refs.\n\n## A Ref ##\n<code>/name/Shabbat.2a</code>\n\nSince Shabbat 2a is a valid Sefaria Ref, and data about this reference is supplied. On the other hand, no suggestions for auto-completion are supplied.\n\n## A random string ##\n<code>/name/foo</code>\n\n It is possible to query any string against the name api. In this case, the name api will attempt to supply the best possible matches to the string.\n\nThe name api will attempt to reverse your keyboard from English to Hebrew (and vice versa) if no matches are found. For example, by typing the word בראשית with an English keyboard I will get crtah\n", "operationId": "getNames", "parameters": [{ "name": "name", "in": "path", "description": "pass an optional search string for looking up inventory", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }], "responses": { "200": { "description": "search results matching criteria", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NameResponse" } } } } }, "400": { "description": "bad input parameter" } } } }, "/api/index": { "get": { "tags": ["Index API"], "description": "Returns an object representing the table of contents of all texts currently known. Texts are grouped by their categories and ordered along with basic metadata for each. Useful for building a table of contents.", "parameters": [{ "name": "with_content_counts", "in": "query", "description": "will return the exact length for each JaggedArrayNode in the index", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }], "responses": { "200": { "description": "Response value (very large)", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/index/titles": { "get": { "tags": ["Index API"], "description": "Returns a list of all known text titles, including title variants and abbreviations. Useful for checking citations or user input of text names.", "parameters": [{ "name": "with_content_counts", "in": "query", "description": "will return the exact length for each JaggedArrayNode in the index", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }], "responses": { "200": { "description": "Returns an object representing the table of contents of all texts currently known. Texts are grouped by their categories and ordered along with basic metadata for each. Useful for building a table of contents.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/index/{title}": { "get": { "tags": ["Index API"], "description": "Returns metadata about the requested text, including section names, title variants, categories, and orders. The data is returned in a legacy form that only supports simple texts. See the two endpoints below.", "parameters": [{ "name": "title", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "Bereshit" } }, { "name": "with_content_counts", "in": "query", "description": "will return the exact length for each JaggedArrayNode in the index", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }], "responses": { "200": { "description": "Returns metadata about the requested text, including section names, title variants, categories, and orders. The data is returned in a legacy form that only supports simple texts. See the two endpoints below.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v2/index/{title}": { "get": { "tags": ["Index API"], "description": "Returns an index record, whether simple or complex, in the new format. The index record will be padded with related information. * references to shared titles are expanded * textual previews for alternate structures are included", "parameters": [{ "name": "title", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "Bereshit" } }, { "name": "with_content_counts", "in": "query", "description": "will return the exact length for each JaggedArrayNode in the index", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }], "responses": { "200": { "description": "Returns an index record, whether simple or complex, in the new format. The index record will be padded with related information. You can also get the raw format using /v2/raw/index", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v2/raw/index/{title}": { "get": { "tags": ["Index API"], "description": "Returns the raw index record, as it is stored in the db. To edit a complex Index record via the API, use /api/v2/raw/index to GET and POST it.", "parameters": [{ "name": "title", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "example": "Bereshit" } }, { "name": "with_content_counts", "in": "query", "description": "will return the exact length for each JaggedArrayNode in the index", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }], "responses": { "200": { "description": "Returns the raw index record, as it is stored in the db. To edit a complex Index record via the API, use /api/v2/raw/index to GET and POST it.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/search/{index}/_search": { "post": { "tags": ["Search API (v1)"], "description": "For the simpler version of this API, see Search API (v2). This API is simply a proxy for the ElasticSearch API which can be fairly complicated.\nMakes a query to Sefaria\\'s search engine and returns results. Note our search engine is built on ElasticSearch. The current version of ElasticSearch we\\'re using is 6.2.3. To read the complete documentation of their API, see their full documentation.\nFull documentation on search is available [here](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search.html)", "parameters": [{ "name": "index", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": ["text", "sheet"] } }], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SearchRequestV1" }, "examples": { "Sample query for extract text results": { "description": "Sample query for extract text results", "value": { "from": 0, "size": 10, "highlight": { "pre_tags": [""], "post_tags": [""], "fields": { "exact": { "fragment_size": 200 } } }, "sort": [{ "comp_date": {} }, { "order": {} }], "query": { "match_phrase": { "exact": { "query": "moshe" } } } } }, "Query using broad analyzer (`sefaria-naive-lemmatizer`)": { "description": "This parses Hebrew queries using heuristics. This involves converting plural to singular, removing prefixes and dealing with מלא and חסר spellings.", "value": { "size": 10, "highlight": { "pre_tags": [""], "post_tags": [""], "fields": { "naive_lemmatizer": { "fragment_size": 200 } } }, "sort": [{ "comp_date": {} }, { "order": {} }], "aggs": { "category": { "terms": { "field": "path", "size": 10000 } } }, "query": { "match_phrase": { "naive_lemmatizer": { "query": "moshe", "slop": 10 } } } } }, "Query text using relevance ranking": { "description": "Query text using relevance ranking. Ranking is based on a variation of the [PageRank](https://en.wikipedia.org/wiki/PageRank) algorithm using our link set plus references cited in source sheets.", "value": { "size": 10, "highlight": { "pre_tags": [""], "post_tags": [""], "fields": { "naive_lemmatizer": { "fragment_size": 200 } } }, "query": { "function_score": { "field_value_factor": { "field": "pagesheetrank", "missing": 0.04 }, "query": { "match_phrase": { "naive_lemmatizer": { "query": "moshe", "slop": 10 } } } } } } }, "Query filtered to a specific book in our library": { "description": "Query filtered to a specific book in our library. NOTE in the filter we include a list of regular expressions that should be matched. In this case, we specify a regex on the `path` field", "value": { "size": 10, "highlight": { "pre_tags": [""], "post_tags": [""], "fields": { "exact": { "fragment_size": 200 } } }, "sort": [{ "comp_date": {} }, { "order": {} }], "query": { "bool": { "must": { "match_phrase": { "exact": { "query": "moshe" } } }, "filter": { "bool": { "should": [{ "regexp": { "path": "Mishnah/Seder Zeraim/Mishnah Kilayim.*" } }] } } } } } } } } } }, "responses": { "200": { "description": "The API returns results in the standard ElasticSearch format.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SearchResults" } } } } } } }, "/api/search/{index}/_analyze": { "post": { "tags": ["Search API (v1)"], "description": "See how a query will be analyzed by ElasticSearch -- [Full Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-analyze.html)", "parameters": [{ "name": "index", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "type": "string", "enum": ["text", "sheet"] } }], "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/body" }, "example": { "analyzer": "standard", "text": "moshe" } } } }, "responses": { "200": { "description": "The API returns ElasticSearch query plan", "content": { "application/json; charset=utf-8": { "schema": { "type": "object" } } } } } } }, "/api/search-wrapper": { "post": { "tags": ["Search API (v2)"], "description": "Simpler search API than Search API (v1) which exposes the main search functionality available on the site.", "requestBody": { "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SearchRequestV2" }, "examples": { "Moshe in any text": { "value": { "query": "Moshe", "type": "text" } }, "Moshe in any source sheet": { "description": "Note you must specify content as the field to search source sheets", "value": { "query": "Moshe", "type": "sheet", "field": "content" } }, "Inexact search for משה רבנו any text": { "description": "Maximum distance b/w search terms is 10 words", "value": { "query": "משה רבנו", "type": "text", "field": "naive_lemmatizer", "slop": 10 } }, "Search for 'Moshe' in Talmud Bavli, Mesekhet Berakhot OR anywhere in Midrash": { "value": { "query": "Moshe", "type": "text", "filters": ["Talmud/Bavli/Berakhot", "Midrash"], "filter_fields": ["path", "path"] } } } } } }, "responses": { "200": { "description": "The API returns results in the standard ElasticSearch format. See Search API (v1) for a brief explanation", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/SearchResults" } } } } } } } }, "components": { "schemas": { "NameResponse": { "required": ["completions", "is_ref", "lang"], "type": "object", "properties": { "lang": { "pattern": "/^[a-z]{2}$/", "type": "string", "example": "en" }, "is_ref": { "type": "boolean", "description": "Is this a Ref or not", "example": false }, "completions": { "type": "array", "items": { "type": "string" } }, "completion_objects": { "type": "array", "items": { "$ref": "#/components/schemas/CompletionObject" } }, "type": { "type": "string", "example": "Topic" }, "key": { "type": "string", "description": "Same text sent to the server", "example": "rashi" } } }, "CompletionObject": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "type": "string" }, "key": { "type": "string" }, "is_primary": { "type": "boolean" } } }, "Link": { "type": "object", "properties": { "_id": { "type": "string", "example": "5896280bd6e4a91d76282ef2" }, "index_title": { "type": "string" }, "category": { "type": "string" }, "type": { "type": "string" }, "compDate": { "type": "integer" }, "errorMargin": { "type": "integer" }, "ref": { "type": "string" }, "anchorRef": { "type": "string" }, "ancorRefExpanded": { "type": "array", "items": { "type": "string" } }, "sourceRef": { "type": "string" }, "sourceHeRef": { "type": "string" }, "anchorVerse": { "type": "integer" }, "sourceHasEn": { "type": "boolean" }, "commentaryNum": { "type": "number" }, "collectiveTitle": { "$ref": "#/components/schemas/Link_collectiveTitle" }, "he": { "type": "string", "description": "Text in hebrew" }, "heVersionTitle": { "type": "string" }, "heLicense": { "type": "string" }, "heVersionTitleInHebrew": { "type": "string" }, "text": { "type": "string", "description": "Text in english" }, "versionTitle": { "type": "string" }, "license": { "type": "string" }, "versionTitleInHebrew": { "type": "string" } } }, "SearchRequestV2": { "required": ["query", "type"], "type": "object", "properties": { "query": { "type": "string", "description": "Your search query" }, "type": { "type": "string", "description": "The index you want to query. See Search API (v2) Index Types for an explanation of each index", "enum": ["text", "sheet", "merged"] }, "field": { "type": "string", "description": "the field you want to query. Common fields to query are exact or `naive_lemmatizer` for the text and merged indexes. For querying the sheets index, commonly you'll query the content field", "default": "exact" }, "source_proj": { "type": "string", "description": "bool, str or list(str) (default=False) by default, the ElasticSearch document is not returned. Specifying True will return the entire document. Specifying a str or list(str) will perform a projection on the document for the specified fields", "default": "false" }, "slop": { "type": "integer", "description": "the maximum distance between each query word in the resulting document. 0 means an exact match must be found", "default": 0 }, "start": { "type": "integer", "description": "for paginating results. The number document to start returning. 0 means start at the first result", "default": 0 }, "size": { "type": "integer", "description": "for paginating results. The total number of results to return, starting from start", "default": 100 }, "filters": { "type": "array", "description": "a list of filters to filter results. These filters can be RegEx if querying the text index. For the sheet type, the filters are applied literally. Each filter is applied to its corresponding entry in the `filter_fields` list", "items": { "type": "string" } }, "filter_fields": { "type": "array", "description": "(required if `filters` is specified). Must be the same length as filters. Each entry specifies the field to apply the corresponding filter in `filters`", "items": { "type": "string" } }, "aggs": { "type": "array", "description": "list of fields to aggregate on. Common fields are `path` for the `text` type and `group` or `tags` for the `sheet` type", "items": { "type": "string" } }, "sort_method": { "type": "string", "description": "how to sort results. If sort the values are sorted according to `sort_fields`. If `score`, the value in `sort_fi