BibleGPT · GPT-Aktionen

{
  "openapi": "3.1.0",
  "info": {
    "title": "ESV Bible API",
    "description": "Allows access to various data from the ESV Bible.",
    "version": "v1.0.0"
  },
  "servers": [
    {
      "url": "https://api.esv.org"
    }
  ],
  "paths": {
    "/v3/passage/text/": {
      "get": {
        "description": "Retrieve Bible text for a given passage in plain text format.",
        "operationId": "GetPassageText",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "description": "The passage query (e.g., John 3:16)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "include-passage-references",
            "in": "query",
            "description": "Include the passage reference before the text.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": true
            }
          },
          {
            "name": "include-verse-numbers",
            "in": "query",
            "description": "Include verse numbers in the passage text.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": true
            }
          },
          {
            "name": "include-first-verse-numbers",
            "in": "query",
            "description": "Include first verse number at the start of each paragraph.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "include-footnotes",
            "in": "query",
            "description": "Include explanatory footnotes.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "include-footnote-body",
            "in": "query",
            "description": "Include body of footnotes inline with the text.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "include-headings",
            "in": "query",
            "description": "Include section headings.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "include-selahs",
            "in": "query",
            "description": "\"Selah\" is included from the Hebrew text.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A passage from the ESV Bible in plain text format."
          }
        },
        "deprecated": false
      }
    },
    "/v3/passage/search/": {
      "get": {
        "description": "Search the ESV Bible for verses that match a word or phrase.",
        "operationId": "SearchPassages",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "description": "The search query, wrapped in double quotes for exact phrases.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page-size",
            "in": "query",
            "description": "The number of results per page, with a maximum value of 100.",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 20
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "The page of results to retrieve, used with page-size.",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Verse results matched by the search query."
          },
          "404": {
            "description": "No verses found matching the search query."
          }
        },
        "deprecated": false
      }
    },
    "/v3/passage/html/": {
      "get": {
        "description": "Retrieve Bible text for a given passage in HTML format with customizable rendering.",
        "operationId": "GetPassageHTML",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "description": "The passage query (e.g., John 3:16 or Genesis 1-2)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "include-passage-references",
            "in": "query",
            "description": "Include passage reference before the text.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "An HTML-rendered passage from the ESV Bible."
          }
        },
        "deprecated": false
      }
    },
    "/v3/passage/audio/": {
      "get": {
        "description": "Provides an MP3 file of a given passage being read from the ESV Bible.",
        "operationId": "GetPassageAudio",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "description": "The passage query (e.g., John 11:35).",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A redirect to the MP3 file of the audio content."
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {}
  }
}