v1

latestOpenAPI 3.0.2GNU AGPLv32026-07-245983524.8 KB

Index

Shape

Retrieve basic statistics and information about the "shape" of an Index on Sefaria.

get/api/shape/{title}

Response

Retrieve basic statistics and information about the "shape" of an Index on Sefaria.

Sectionstring

The parent section for this Index. (So for example, the section for Jonah is Prophets. The section for Pesachim is Seder Moed)

isComplexboolean

A boolean representing whether or not this is a complex text.

{"stackTrail":"components:schemas:ShapeJSON:properties:Length","oasType":"schema","type":"unknown","description":"The number of chapters or top-level sections in the `Index`. "}

Bookstring

Title of the Index in English

heBookstring required

Title of the Index in Hebrew.

Chaptersinteger[]

For simple texts, this is a list of chapter lengths. For complex texts or categories, the Shape API will return a list of dicts for each text within that category or text.

Example response

{
  "Section": "Prophets",
  "Chapters": [
    16,
    11,
    10,
    11
  ]
}