NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
API.Bible connects to a Nagent workspace with an API key. Once it is connected, agents can call 19 API.Bible actions, such as "Get All Books", "Get Audio Bible by ID" and "Get Audio Book". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against API.Bible, with input parameters and output schema.
API_BIBLE_GET_ALL_BOOKSRetrieve all books for a specific Bible version. Requires a valid Bible version ID (obtainable from Get Supported Versions). Returns a list of books with their IDs, names, and abbreviations in the Bible's native language.
Input parameters
Unique identifier of the Bible version to retrieve books from (e.g., 'de4e12af7f28f599-01')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_GET_AUDIO_BIBLETool to retrieve details of a specific audio Bible by its ID. Use when you need metadata about an audio Bible version.
Input parameters
Unique identifier of the audio Bible to retrieve (e.g., '52a82b80a85343c5-01')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_GET_AUDIO_BOOKTool to retrieve a single audio Book object for a given audio Bible ID and book ID. Use when you need metadata about a specific audio book.
Input parameters
Id of the Book to fetch (e.g., 'MAT' for Matthew, 'GEN' for Genesis)
Id of audio Bible whose Book to fetch
Boolean indicating if an array of chapter summaries should be included in the results. Defaults to false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_GET_AUDIO_CHAPTERTool to retrieve a single audio chapter with mp3 resource URL. Use when you need to fetch audio content for a specific chapter of an audio Bible. The resourceUrl provided in the response is temporary and expires after a certain time (indicated by expiresAt).
Input parameters
ID of the chapter to fetch. Format: BOOK.CHAPTER (e.g., 'MAT.1' for Matthew chapter 1, 'GEN.5' for Genesis chapter 5)
ID of the audio Bible whose chapter to fetch (e.g., '52a82b80a85343c5-01')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_GET_BIBLETool to retrieve details of a specific Bible version by its ID. Use when you need full metadata after listing versions. Example prompt: 'Get metadata for bibleId de4e12af7f28f599-01'.
Input parameters
Unique identifier of the Bible version to retrieve (e.g., 'de4e12af7f28f599-01')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_GET_BOOKTool to retrieve a single Book object for a given Bible version and book ID. Use when you need details about a specific book, optionally including its chapters.
Input parameters
Id of the Book to fetch (e.g., 'GEN' for Genesis, 'MAT' for Matthew, 'MRK' for Mark)
Unique identifier of the Bible version (e.g., '87888656306da642-01', 'de4e12af7f28f599-01')
Boolean indicating if an array of chapter summaries should be included in the results. Defaults to false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_GET_CHAPTERRetrieve a complete chapter with all verses from a Bible version. Use when you need to fetch an entire chapter's content including all verses, navigation to adjacent chapters, and copyright information. First use Get Supported Versions to obtain valid Bible IDs.
Input parameters
ID of the Bible version to fetch from. Obtain from Get Supported Versions action (e.g., 'de4e12af7f28f599-02').
ID of the chapter to retrieve. Format: BOOK.CHAPTER (e.g., 'GEN.1' for Genesis chapter 1, 'JHN.3' for John chapter 3).
Comma-separated list of Bible IDs to include for parallel content comparison.
Format of chapter content: 'html' (default), 'json' (beta), or 'text' (beta).
Include footnotes in content.
Include section titles in content.
Include spans that wrap verse numbers and verse text for bible content.
Include verse numbers in content.
Include chapter numbers in content.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_GET_PASSAGERetrieve a Bible passage by ID. A passage can represent a chapter, verse, or range of verses. Use when you need to fetch specific scripture content with configurable display options.
Input parameters
ID of the Bible version to fetch from. Obtain from Get Supported Versions action (e.g., 'de4e12af7f28f599-01').
Comma-delimited list of bibleIds to include for parallel content comparison.
String reference id for the requested passage. Can represent a chapter, verse, or range of verses (e.g., 'JHN.3.16', 'MAT.1', 'MAT.1.12-MAT.1.20').
Use the supplied id(s) to match the verseOrgId instead of the verseId.
Format of passage content: 'html' (default), 'json' (beta), or 'text' (beta).
Include footnotes in content.
Include section titles in content.
Include spans that wrap verse numbers and verse text for bible content.
Include verse numbers in content.
Include chapter numbers in content.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_GET_SECTIONRetrieve detailed content for a Bible section by ID. A section represents a thematic grouping of verses (e.g., 'The Genealogy of Jesus', 'The Sermon on the Mount'). First use Get Sections to obtain section IDs for a specific book, then use this action to fetch the full content with configurable display options.
Input parameters
ID of the Bible version to fetch from. Obtain from Get Supported Versions action (e.g., 'b17e246951402e50-01').
Comma-separated list of Bible IDs for parallel content comparison.
ID of the section to retrieve. Obtain from Get Sections action. Format: BOOK.S# (e.g., 'MAT.S1' for first section of Matthew).
Format of section content: 'html' (default), 'json', or 'text'.
Include footnotes in content.
Include section titles in content.
Include verse spans in content.
Include verse numbers in content.
Include chapter numbers in content.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_GET_SECTIONSTool to retrieve a list of sections for a specific book in a Bible version. Use after obtaining the Bible and book IDs to view sectional breakdown.
Input parameters
The USFM book ID (e.g., 'GEN' for Genesis, 'MAT' for Matthew, 'REV' for Revelation). The book must exist in the specified Bible version.
The ID of the desired Bible version. Note: Not all Bible versions have sections. Use a version that supports sections such as 'b17e246951402e50-01' (Arabic Open NAV).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_GET_SUPPORTED_VERSIONSRetrieve a list of available Bible versions (translations) from API.Bible. Use this tool to: - List all available Bible translations before searching for verses - Find Bible versions by language (e.g., English, Spanish, German) - Search for specific translations by name or abbreviation - Get the Bible version ID needed for other API.Bible operations The returned version IDs can be used with other API.Bible tools to access specific Bible content like books, chapters, verses, and sections.
Input parameters
Search term to filter Bible versions by name. Partial matches are supported.
ISO 639-3 three-digit language code to filter Bible versions (e.g., 'eng' for English, 'spa' for Spanish, 'deu' for German).
Search term to filter Bible versions by abbreviation (e.g., 'KJV', 'NIV').
If True, include extended details like copyright information and full language data.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_GET_VERSERetrieve a specific Bible verse by ID. Use this action when you need to fetch the content of a single verse from a specific Bible version. First use Get Supported Versions to obtain a valid bibleId, then provide the verse ID in format BOOK.CHAPTER.VERSE (e.g., 'JHN.3.16' for John 3:16). Configurable display options allow control over footnotes, titles, and verse numbering.
Input parameters
ID of the Bible version to fetch from. Obtain from Get Supported Versions action (e.g., 'de4e12af7f28f599-01').
String reference ID for the requested verse. Format: BOOK.CHAPTER.VERSE (e.g., 'JHN.3.16' for John 3:16).
Comma-separated list of Bible IDs for parallel content comparison.
Use the supplied id(s) to match the verseOrgId instead of the verseId.
Format of verse content: 'html' (default), 'json' (beta), or 'text' (beta).
Include footnotes in content.
Include section titles in content.
Include spans that wrap verse numbers and verse text for bible content.
Include verse numbers in content.
Include chapter numbers in content.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_LIST_AUDIO_BIBLESTool to retrieve an array of audio Bible objects authorized for the current API Key. Use when you need to discover available audio Bible versions, filter by language, name, or abbreviation.
Input parameters
Comma-separated list of Bible IDs to return (e.g., '105a06b6146d11e7-01,de4e12af7f28f599-02').
Bible name to search for. Partial matches are supported.
Bible ID of related text Bible used to filter audio Bible results.
ISO 639-3 three-digit language code used to filter audio Bible results (e.g., 'eng' for English, 'spa' for Spanish).
Bible abbreviation to search for (e.g., 'ENGESVN2DA', 'ENGESV').
If True, include full Bible details such as copyright information, promotional info, and language script details.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_LIST_AUDIO_BOOKSTool to retrieve all books for a specific audio Bible version. Use when you need to list available audio books for a given audio Bible ID. Returns a list of books with their IDs, names, and abbreviations in the Bible's native language.
Input parameters
Unique identifier of the audio Bible version to retrieve books from (e.g., '52a82b80a85343c5-01')
Boolean indicating if an array of chapter summaries should be included in the results. Defaults to false.
Boolean indicating if an array of chapter summaries and an array of sections should be included in the results. Defaults to false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_LIST_AUDIO_CHAPTERSTool to retrieve a list of audio chapters for a specific book in an audio Bible version. Use after obtaining the audio Bible ID and book ID to view available audio chapters.
Input parameters
The USFM book ID to retrieve chapters for (e.g., 'GEN' for Genesis, 'MAT' for Matthew, 'REV' for Revelation). The book must exist in the specified audio Bible version.
The ID of the desired audio Bible version (e.g., '52a82b80a85343c5-01'). Use Get Supported Versions to find available audio Bible IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_LIST_CHAPTERSTool to retrieve an array of Chapter objects for a given Bible version and book. Use after obtaining the Bible and book IDs to view all chapters available.
Input parameters
Id of the Book whose Chapters to fetch (e.g., 'GEN' for Genesis, 'MAT' for Matthew)
Id of Bible whose Chapters to fetch (e.g., 'de4e12af7f28f599-02')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_LIST_CHAPTER_SECTIONSTool to retrieve an array of section objects for a specific chapter in a Bible version. Use after obtaining the Bible and chapter IDs to view sectional breakdown of a chapter.
Input parameters
The ID of the desired Bible version. Note: Not all Bible versions have sections. Use a version that supports sections.
The chapter ID (e.g., 'MRK.1' for Mark chapter 1, 'GEN.1' for Genesis chapter 1). The chapter must exist in the specified Bible version.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_LIST_VERSESTool to retrieve an array of verses for a specific chapter in a Bible version. Use after obtaining Bible and chapter IDs to get all verses in that chapter.
Input parameters
The ID of the desired Bible version (e.g., 'de4e12af7f28f599-02'). Obtain from Get Supported Versions.
The ID of the chapter to retrieve verses from (e.g., 'GEN.1' for Genesis chapter 1, 'MAT.5' for Matthew chapter 5). Format is typically <BOOK_ID>.<CHAPTER_NUMBER>.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
API_BIBLE_SEARCH_VERSESSearch for Bible verses containing specified keywords or passage references. This tool searches within a specific Bible version for verses matching your query. For keyword searches, all keywords must be present in a verse to match. You can also search by passage reference (e.g., 'John 3:16-19'). Use API_BIBLE_GET_SUPPORTED_VERSIONS to get valid Bible version IDs.
Input parameters
Maximum number of results to return (1-100). Defaults to 10 if not specified.
Search query string. Can be keywords (e.g., 'love', 'faith hope') where all keywords must be present in a verse, or a passage reference (e.g., 'John 3:16').
Number of results to skip for pagination (0-based). Use with limit to paginate through large result sets.
Bible version ID to search within. Use API_BIBLE_GET_SUPPORTED_VERSIONS to get valid IDs (e.g., 'de4e12af7f28f599-01' for KJV, '9879dbb7cfe39e4d-01' for WEB).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 19 API.Bible actions on Nagent, including "Get All Books", "Get Audio Bible by ID" and "Get Audio Book". Get All Books: Retrieve all books for a specific Bible version. Each action is listed on this page with its input parameters and its output.
API.Bible connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get All Books takes 1 required input: bibleId. It returns data, error and successful.