REST API

{
  "languages": [
    {
      "code": "en",
      "name": "English",
      "direction": "ltr"
    },
    {
      "code": "es-419",
      "name": "Español (Latinoamérica)",
      "direction": "ltr"
    }
  ]
}

{
  "reference": "TIT 2:12",
  "language": "en",
  "book": "TIT",
  "chapter": "2",
  "verse": "12",
  "format": "plain",
  "versions": [
    {
      "resourceType": "ult",
      "role": "literal",
      "text": "training us so that we can reject ungodliness…",
      "source": "https://git.door43.org/…"
    },
    {
      "resourceType": "ust",
      "role": "simplified",
      "text": "By means of this free gift, God trains us…",
      "source": "https://git.door43.org/…"
    },
    {
      "resourceType": "ugnt",
      "role": "original",
      "text": "παιδεύουσα ἡμᾶς…",
      "source": "https://git.door43.org/…"
    }
  ],
  "meta": {
    "cache": "kv",
    "timings": {
      "totalMs": 42
    }
  }
}

{
  "reference": "TIT 2:12",
  "language": "en",
  "notes": [
    {
      "book": "TIT",
      "chapter": "2",
      "verse": "12",
      "id": "abc123",
      "supportReference": "rc://*/ta/man/translate/figs-personification",
      "supportReferenceTitle": "Personification",
      "quote": "παιδεύουσα ἡμᾶς",
      "occurrence": "1",
      "note": "Here, **grace** is spoken of as if it were a person who trains us…",
      "gatewayQuote": {
        "original": "παιδεύουσα ἡμᾶς",
        "aligned": "training us"
      }
    }
  ],
  "meta": {
    "cache": "kv"
  }
}

{
  "reference": "TIT 2:12",
  "language": "en",
  "wordLinks": [
    {
      "book": "TIT",
      "chapter": "2",
      "verse": "12",
      "id": "def456",
      "twLink": "rc://*/tw/dict/bible/kt/righteous",
      "twTitle": "righteous, righteousness",
      "origWords": "δικαίως",
      "occurrence": "1",
      "gatewayQuote": {
        "original": "δικαίως",
        "aligned": "righteous"
      }
    }
  ],
  "meta": {
    "cache": "kv"
  }
}

{
  "reference": "TIT 2:12",
  "language": "en",
  "questions": [
    {
      "id": "tq1",
      "reference": "2:12",
      "question": "What does God's grace train us to do?",
      "response": "To reject ungodliness and worldly passions…"
    }
  ],
  "meta": {
    "cache": "kv"
  }
}

{
  "language": "en",
  "articles": [
    {
      "path": "kt/grace",
      "title": "grace, gracious",
      "category": "kt"
    },
    {
      "path": "other/angel",
      "title": "angel, archangel",
      "category": "other"
    }
  ]
}

{
  "language": "en",
  "path": "kt/grace",
  "title": "grace, gracious",
  "article": "# grace, gracious\n\n### Definition:\nThe word **grace**…\n"
}

{
  "language": "en",
  "articles": [
    {
      "path": "translate/figs-metaphor",
      "title": "Metaphor",
      "category": "translate"
    }
  ]
}

{
  "language": "en",
  "path": "translate/figs-metaphor",
  "title": "Metaphor",
  "article": "# Metaphor\n\n### Description\nA metaphor…\n"
}

{
  "reference": "TIT 2:12",
  "language": "en",
  "quote": "γάρ",
  "occurrence": 1,
  "match": {
    "original": "γάρ",
    "aligned": "for",
    "ok": true
  }
}

{
  "query": "metaphor",
  "language": "en",
  "results": [
    {
      "type": "ta",
      "path": "translate/figs-metaphor",
      "title": "Metaphor",
      "snippet": "A metaphor is a figure of speech…",
      "score": 12.4
    }
  ]
}

{
  "language": "en",
  "requestedLanguage": "en",
  "available": [
    {
      "type": "scripture",
      "subject": "Aligned Bible",
      "abbreviation": "ult",
      "role": "literal"
    },
    {
      "type": "notes",
      "subject": "TSV Translation Notes",
      "abbreviation": "tn",
      "role": "notes"
    }
  ],
  "requestId": "req_…"
}

{
  "status": "accepted",
  "reference": "TIT 2:12",
  "language": "en"
}

{
  "reference": "3:1-3",
  "language": "es-419",
  "story": 3,
  "title": "Noah and the Great Flood",
  "frames": [
    {
      "index": 1,
      "imageUrl": "https://cdn.door43.org/obs/en/obs/01/01.jpg",
      "text": "A long time ago, the world had become very wicked…"
    },
    {
      "index": 2,
      "imageUrl": "https://cdn.door43.org/obs/en/obs/01/02.jpg",
      "text": "God saw that the people on earth were very wicked…"
    },
    {
      "index": 3,
      "imageUrl": "https://cdn.door43.org/obs/en/obs/01/03.jpg",
      "text": "So God decided to send a great flood…"
    }
  ],
  "attribution": "© unfoldingWord"
}

{
  "reference": "1:1",
  "language": "en",
  "notes": [
    {
      "id": "obs-n1",
      "reference": "1:1",
      "quote": "God",
      "note": "This refers to the one true God…"
    }
  ]
}

{
  "reference": "1:1",
  "language": "en",
  "questions": [
    {
      "id": "obs-q1",
      "reference": "1:1",
      "question": "Who made everything?",
      "response": "God"
    }
  ]
}