Jump to Content
Sefaria
HomeDocsAPI ReferenceGet in Touch
Sefaria.orgJobs at SefariaGitHubSefaria
Docs
Sefaria.orgJobs at SefariaGitHub
HomeDocsAPI ReferenceGet in Touch

TECHNICAL DOCS

  • Welcome
  • Copyright and Data Use
  • The Structure of a Book on Sefaria
    • Index and Versions
    • The Index Schema
      • JaggedArray and JaggedArray Nodes
      • SchemaNode
      • The Structure of a Simple Text
      • The Structure of a Complex Text
      • Node Titles
    • Alternate Structures
    • Commentaries
    • Terms
    • Lexicon
  • Text References
  • Categories
  • Topic Ontology
    • Linear Integer Programming For Topic Pages Sources Selection
  • Formatting within Sefaria Texts
  • Additional API Endpoints
    • Elastic Search Proxy API
  • Linker
    • Linker v2
    • Linker v3
    • Linker API
    • How to Format Citations for the Linker
    • איך ליצור מראי מקורות להפניה - How to Format Citations (HE)
    • Websites Using the Sefaria Auto Linker
  • Migrating Source Sheets via the Sefaria API
  • Sefaria GitHub

local installation

  • Getting Started
  • Local Installation Instructions
    • Run Sefaria with Docker-Compose
  • Workflowy
  • CLI
  • Technical Notes
    • Term Creation
    • Titles for Index
    • Category Creation

Dev Digest Archive

  • Linear Programming, Topic Curation, and API Tips (December 2024, Issue 3)
  • Celery Queues, Local Install and the Shape API (September 2024, Issue 2)
  • All About Texts, Volunteering for Tests (June 2024, Issue 1)
  • Top Tech Tips, New Projects, and More! (March 2025, Issue 4)

about Sefaria

  • General FAQ
  • Projects Powered By Sefaria
  • Guide to Contributing
    • How to Report a Mistake

Getting Started

Suggest Edits

We recommend that users wishing to interact with Sefaria use our public API to do so. The docs in this section are only relevant to users who wish to work with the local set up.

Updated about 2 months ago