compare_narrations
ChatGPTList how narrations (riwayat) differ on one Madani mushaf page, for example how Warsh 'an Nafi' reads a word unlike Hafs 'an Asim. Suits studying the qira'at. Each difference has the narrator's name, the passage (difference_text) and how that narration reads it (difference_content), in Arabic, and the words with their location 'surah:ayah:word'; a page without differences gives an empty list.
compare_words
ChatGPTCompare 2-10 Quran words morphologically: each word's location, text, tags_count, categories and tag_codes, plus common_tags (code, Arabic meaning, category), unique_to_each (each location's own codes) and similarity_score (percent). Use it to see what words share, such as two forms of a root. Repeated locations count once; a location with no word is left out and listed in missing_locations, and at least 2 must exist.
find_words_in_layout
ChatGPTFind the pages and lines that hold a range of word ids in a mushaf layout. Layouts number words from 1 (the first word of Al-Fatiha): most use QuranHub's word numbering, where the first ayah is ids 1-4 and the last id is 77429; 'uthmani-15-lines' and 'qpc-nastaleeq-15-lines' also count ayah-end markers, so their first ayah is 1-5 and their last id is 83668 and 83653. from_word and to_word are inclusive and at most 20 apart. Each line has pageNumber, lineNumber, lineType, isCentered and the fromWord-toWord ids it holds, which can extend past the range. With include_glyphs (qpc-v1-15-lines, qpc-v2-15-lines and qpc-v4-tajweed-15-lines) each ayah line also lists its glyphs. get_word_line_number takes a 'surah:ayah:word' location instead.
get_ayah
ChatGPTReturn one ayah (verse) with its surah, juz, page and sajda details, in up to 10 editions (scripts, narrations, translations, tafsir, recitations); several give a list, one entry per edition. Suits quoting a verse, comparing translations or reading tafsir.
get_ayah_audio
ChatGPTReturn one ayah recited by a verse-by-verse reciter, for playing a single verse: audio (MP3 URL, highest bitrate), audioSecondary (other bitrates), the ayah's Arabic text, surah, juz, page, sajda and edition. Reciters of other narrations (for example 'ar.husary.warsh') follow that narration's numbering and text (Warsh 2:255 is Hafs 2:256). Editions without 'versebyverse' in list_reciters types have no per-ayah audio; the error then points to get_surah_audio or get_word_audio.
get_ayah_morphology
ChatGPTMorphological analysis of an ayah word by word (text, location, position, tags by category), concise or detailed as in get_word_morphology. Use it to parse (i'rab) or study a verse. data has the surah, ayah number and simple ayah text once. Paged by word: default 10, at most 20, fewer when analyses are long (a page stops near 90,000 characters); pagination.total is the word count. category or include_meaning=false shrink the answer. 'خص' is on every word and is not its root.
get_ayah_tajweed
ChatGPTReturn the tajweed rules of every word of one ayah, for explaining its recitation or colouring its letters: each word's position, location, Uthmani text and tajweed.rules (empty when none apply). Each rule has cls, span (its letters; ى may stand for a final ي, ا for أ), len and offset; span starts at character (offset - 1) / 2 of the word text, from 0.
get_ayah_themes
ChatGPTReturn the themes (topics) of one ayah, for example 1:1 -> 'Supplication to Allah for guidance taught by Allah Himself', each with name, keywords and totalAyahs. Only part of the Quran is themed: many ayahs have an empty list. Hafs numbering.
get_edition
ChatGPTReturn one edition's details by identifier, for example 'en.sahih' (translation), 'ar.muyassar' (tafsir) or 'ar.alafasy.hafs' (recitation): language, name, englishName, format, type, direction and narratorIdentifier. Recitations add imageUrl, shortDescription, nationality, recitationType and, with several audio types, 'types'; tafsirs add imageUrl. An unknown identifier gives an error suggesting close matches.
get_editions_statistics
ChatGPTReturn statistics on the whole edition catalogue: totals (editions, text, audio, audio files), counts per format, type, language and narration, and reciters (total, by nationality); for questions such as how many translations or recitations exist.
get_font
ChatGPTReturn one Quran font by code: name, category ('Quran' renders the whole text, 'Page by Page' has one font per mushaf page), download files grouped by kind, each with format and url, and pageRange (null unless page by page). No tool lists all fonts; list_mushaf_layouts shows each layout's font code.
get_font_page_files
ChatGPTReturn the per-page files of a page-by-page font ('qpc-v1', 'qpc-v2' or the colour 'qpc-v4-tajweed': one font per mushaf page, pages 1-604). With page: that page's URLs keyed by format ('ttf', 'woff', 'woff2'); format keeps one. Without page: the page files in page order (pageNumber, format, url), optionally of one format, paged by offset/limit (one file per page and format). Other fonts have none.
get_full_quran
ChatGPTRead the whole Quran in order, 1:1 to 114:6, a page of ayahs at a time (text, surah number, number in the surah). Suits reading or exporting the text in sequence, also in a narration such as quran-warsh. pagination.total is 6236 or the edition's own count (6213 in Warsh); long editions may return fewer ayahs (size_limited=true).
get_morphology_statistics
ChatGPTMorphology statistics for the Quran or one surah: overview, by_category (unique_tags, total_occurrences, avg_per_word), top_roots and top_tags. With surah they sit in data.statistics, and data.surah_profile adds word and ayah counts, unique_roots, most_common_root, verb_tenses and complexity_score. category limits by_category to it. For a surah, coverage and top_roots percentages are of all the Quran's words, top_tags ones of the surah's. 'خص', on every word, heads top_roots, top_tags and most_common_root.
get_morphology_tag
ChatGPTDetails of one morphological tag by code, for example 'ب46' (genitive noun after a preposition): meaning, user_meaning (Arabic) and category; statistics (total_words, surahs_count, percentage_of_quran); related_tags most often found with it; example words with location and ayah text. Use it to explain a code from a word's analysis; list_morphology_tags finds codes.
get_mushaf_layout
ChatGPTReturn one mushaf layout by code: name, numberOfPages, linesPerPage and font (code, name, category). Use it to check a layout's page count before get_mushaf_page_lines, or which font renders it.
get_mushaf_page_lines
ChatGPTReturn the lines of one page of a mushaf layout, in order: lineNumber, lineType ('surah_name', 'basmallah' or 'ayah'), isCentered, surahNumber (on 'surah_name' lines) and, on ayah lines, the first and last word as word ids (fromWord, toWord) and as 'surah:ayah:word' (fromLocation, toLocation). Page 1 of 'qpc-hafs-15-lines' has 8 lines. With include_glyphs (qpc-v1-15-lines, qpc-v2-15-lines and qpc-v4-tajweed-15-lines) each ayah line also lists its glyphs in reading order, ayah-end markers included (location, isAyahMarker, code, page): drawn right to left with that page's font from get_font_page_files, they reproduce the printed line.
get_mushaf_surah_lines
ChatGPTReturn every line a mushaf layout gives a surah, in page and line order: its heading ('surah_name'), its basmallah line and its ayah lines, each with pageNumber, lineNumber, lineType, isCentered and the first and last word (fromWord/toWord ids, fromLocation/toLocation as 'surah:ayah:word'; null on heading lines). Surah 2 starts on page 2, line 1 in 'qpc-hafs-15-lines'. With include_glyphs (qpc-v1-15-lines, qpc-v2-15-lines and qpc-v4-tajweed-15-lines) each ayah line also lists its glyphs in reading order, ayah-end markers included. The longest surahs are too large for one answer (surah 2 with glyphs, or in the 13-line Indo-Pak layouts): the error names their pages, which get_mushaf_page_lines returns one at a time.
get_mutashabihat
ChatGPTFind the mutashabihat of an ayah: its phrases that recur, identically or nearly, elsewhere in the Quran, for example 'إِنَّ فِي ذَٰلِكَ لَأٓيَةٗ' in 26:8; for hifz review. Items are ayahs (text, surah, numberInSurah, juz, page...) with the repeated phrase (phraseText) at word positions startPos-endPos; the given ayah can be one of them. None for many ayahs: an empty list and a note. 20 per page (at most 50). Text editions only; a narration edition's own ayah numbering applies.
get_quran_section
ChatGPTReturn a page of ayahs (text, number in the surah, surah number) from a juz (1-30), hizb (1-60), hizb quarter (1-240), manzil (1-7), ruku (1-556) or mushaf page (1-604 in the Madani mushaf), with their surahs and edition; a page also has its top surah, juz and hizb numbers. Suits reading a juz or a page, or a reading plan. pagination.total is given for a manzil, a ruku, a layout page or at the end. Long editions may return fewer ayahs, with size_limited=true. Narration editions such as quran-warsh have no rukus.
get_quran_structure
ChatGPTReturn the Quran's structure: the counts of ayahs, surahs, sajdas, rukus, pages, manzils, hizb quarters and juz; every surah (number, names, revelation place and order, ayah count, pages) and sajda (surah, ayah, recommended or obligatory); and for the other divisions 'starts': where number 1, 2, 3... begins, as 'surah:ayah'.
get_random_ayah
ChatGPTReturn a random ayah with its surah, juz, page and sajda details; each call makes a new random choice. Suits a verse of the day or a quiz. With several editions, data is a list with the same ayah in each; reference gives it as 'surah:ayah'.
get_section_metadata
ChatGPTReturn where each juz (30), hizb (60) or mushaf page (604) begins: number, first page, first ayah and its surah. Suits finding which ayah starts juz 15 or page 300, or a table of contents. Paged with offset/limit: all juz or hizbs by default, 20 pages at a time; with long texts fewer come back (size_limited=true).
get_similar_ayahs
ChatGPTFind ayahs worded like a given ayah, for example those sharing phrases with Ayat al-Kursi (2:255), to compare close verses or tell them apart in memorisation. Items are ayahs (text, surah, numberInSurah, juz, page...) with score (0-100), coverage, matchedWordsCount and spans (matched word positions and text). None for many ayahs: an empty list and a note. 20 per page (at most 50). Text editions only; a narration edition's own ayah numbering applies.
get_surah
ChatGPTReturn a surah (chapter) with its names, meaning, revelation place and ayah count, and a page of its ayahs (number in the surah, text, audio for recitation editions); with several editions, data is a list with one surah per edition. Suits reading or quoting a passage with a translation or audio. Narrations such as quran-warsh may have fewer ayahs (see pagination.total). Long editions may return fewer ayahs, with size_limited=true.
get_surah_audio
ChatGPTReturn one reciter's recitation of a whole surah, for playing or linking it: audio (MP3 URL, highest bitrate), audioSecondary (other bitrates, may be empty), the surah's details and the audio edition, without ayah texts. A text edition, or one without full-surah files (word-by-word), is an error that says so.
get_tafsir
ChatGPTReturn one ayah's tafsir (commentary) from one tafsir edition: meaning, grammar (i'rab), rare words (gharib) or readings (qiraat), by tafsir. Default ar.muyassar (short, Arabic); others include 'ar.ibnkathir', 'ar.tabari' and 'en.muyassar' (all: list_editions with type 'tafsir'). The result has the tafsir text, the edition and the ayah's number, surah, juz and page. Classical tafsirs can reach tens of thousands of characters per ayah.
get_tajweed_rule
ChatGPTReturn one tajweed rule, for explaining a cls of 'advanced' tajweed results: rule_key, name and description. With a language, name and description are plain strings; without, objects keyed by language code.
get_word_audio
ChatGPTReturn word pronunciation audio from a word-by-word edition, for hearing or teaching a word. One word: its text, global number, audio (MP3 URL) and audioSecondary. A whole ayah: words with those fields plus position and location. audio is null for the few unrecorded words; positions follow the Hafs word breakdown. Surah and verse-by-verse reciters have no word audio.
get_word_image
ChatGPTReturn a PNG image URL (img_url) of one word in tajweed colours, for showing how it looks in the mushaf. image_type 'rq' (default) is the ReciteQuran QPC Hafs image and 'qa' the Quran Academy image, each in its own palette; both cover every word. 'v4', the V4 tajweed glyph, misses many words (for example 2:255:1): img_url is then null, with a note.
get_word_line_number
ChatGPTReturn a word's line on its mushaf page: line_number, 1-15 as on a 15-line Madani page (pages 1 and 2 use the lower lines; 1:1:1 is line 9). get_ayah gives the ayah's page; find_words_in_layout gives page and line in a chosen mushaf layout.
get_word_morphology
ChatGPTMorphological analysis of one Quran word: root, pattern (wazn), i'rab, verb and noun features, affixes and tajweed markers, as tags by category. Use it to explain a word's grammar or derivation. Returns the word (text, location, surah, ayah number, simple ayah text) and its tags: concise maps tag codes to short Arabic labels; detailed lists full tag records (tags_by_category). 'خص' is a Root tag of every word; the word's own root is the other one. get_morphology_tag explains codes.
get_word_tajweed
ChatGPTReturn the tajweed rules of one word (get_ayah_tajweed covers a whole ayah): location and tajweed (Uthmani text and rules, empty when none apply). Each rule has cls, span (its letters; ى may stand for a final ي, ا for أ), len and offset; span starts at character (offset - 1) / 2 of the word text, from 0.
list_arabic_roots
ChatGPTList the Quran's Arabic roots with word and surah counts.Use it to find frequent roots, browse them alphabetically or pick input for search_words_by_root. Paged: default 20, at most 50; pagination.total counts the matching roots. Particles and proper names count as roots (for example 'في', 'إبراهيم'). 'خص', attached to every word, always leads by frequency; the first lexical root is 'أله'.
list_edition_options
ChatGPTList the values the edition catalogue uses, for list_editions filters or picking a narration: 'languages' (codes such as 'ar' or 'knx'), 'types', 'formats' ('text', 'audio'), 'narrations' (riwayah identifiers such as 'quran-warsh') or, with type, 'subtypes' (type 'tafsir' gives 'tafsir', 'irab', 'qiraat' and 'gharib'). Returns a short list of strings.
list_editions
ChatGPTList the catalogue's editions, optionally filtered, to find the identifiers other tools take, for example English translations (type 'translation', language 'en'); list_edition_options lists filter values. Types: Arabic script ('quran'), narration (riwayah) text, translation, tafsir, transliteration, recitation ('surah': a file per surah, 'versebyverse': per ayah, 'wordbyword': per word). Items have identifier, names, language, format, type, direction and narratorIdentifier; with type 'tafsir', translatedName instead of englishName, plus level and imageUrl; with format 'audio', reciter details. A reciter appears once per audio type. 20 editions per page (at most 50), with a total; no match gives an empty list and a note.
list_font_files
ChatGPTList one Quran font's download files: kind ('regular' plain file, 'pack' archive, or 'extras'), format and url. Optional filters combine, for example kind 'regular' with format 'woff2' for a web font; an empty list means no file matches. Page-by-page fonts list only packs here; get_font_page_files gives their per-page files.
list_font_options
ChatGPTReturn one fixed list of font values, as strings. 'kinds', 'formats' and 'archives' are the values the filters of list_font_files accept (for example 'formats' gives 'json', 'otf', 'ttf', 'woff', 'woff2'); 'categories' are the font categories ('Page by Page', 'Quran', 'Surah by Surah').
list_morphology_categories
ChatGPTList the categories that group the morphological tags:code (the category value other morphology tools take, for example 'Afal'), Arabic and English names, description and tag_count.
list_morphology_tags
ChatGPTList the morphological tags with code, meaning and user_meaning (Arabic), category and usage_count. Use it to find codes for the tag searches and get_morphology_tag. Filter by category and by search text matched against code and meaning (for example 'ماض' for past tense, 'وزن' for patterns). data.categories counts every category's tags. Paged: default 20, at most 50; pagination.total counts the matches.
list_mushaf_layouts
ChatGPTList the printed mushaf layouts: code, name, numberOfPages (604 for the 15-line Madani layouts; Indo-Pak and Nastaleeq layouts differ), linesPerPage and font.Use it to find the layout_code the other mushaf tools take and a layout's font_code. Optional filters match exactly and combine; paged by offset/limit; no match gives an empty list and a note.
list_quran_themes
ChatGPTList the themes (topics) ayahs are grouped under, for example 'Reward for the believers', each with name, keywords and totalAyahs. 20 themes per page (at most 50); with no total, has_more is true whenever a page is full, and an offset past the end gives an empty list.
list_reciter_nationalities
ChatGPTList reciter nationalities, most reciters first (all in one response): two-letter code (for example 'EG'), English and Arabic country names, and reciter and edition counts. code is list_reciters' nationality filter.
list_reciters
ChatGPTList reciters and their audio editions by narration (riwayah), nationality and language, to find the identifier that get_surah_audio and get_ayah_audio take (for example 'ar.alafasy.hafs'). types shows the audio each edition has ('surah': whole surahs, 'versebyverse': single ayahs). Without a narration or nationality, items are distinct reciters with no identifier. No match gives an empty list and a note; an unknown narration is an error listing valid ones. Paged.
list_sajda_ayahs
ChatGPTList the 15 ayahs of prostration (sajdat al-tilawa), each with its text, numbers, surah, juz, page and sajda object (id 1-15, recommended or obligatory). Narration editions such as quran-warsh use their own numbering.
list_surahs
ChatGPTList the 114 surahs (chapters) with number, Arabic and English names and ayah count, to find a surah's number or length. order='revelation' follows the traditional order of revelation from Al-Alaq (with revelationOrder). group_by='revelation_place' splits Meccan and Medinan; group_by='juz' gives each juz's surahs with their pages there, without ayah counts. Groups are in mushaf order only.
list_tajweed_rules
ChatGPTList the catalogue's tajweed rules (such as ghunnah, ikhfa, iqlab, idgham, izhar, madd, qalqalah, hamzat al-wasl, silent letters, tafkheem and tarqeeq):rule_key, the cls of 'advanced' tajweed results, and name, plus description in 'detailed'. With a language, texts are plain strings; without, objects keyed by language code.
search_quran
ChatGPTSearch the Quran text or a translation for a word or phrase, for example 'mercy' or 'الرحمن الرحيم', and return the matching ayahs. Without edition, Arabic-script queries search quran-simple-clean and others en.sahih; language does not pick the text, so a French query needs a French edition. exact true matches whole words or phrases in mushaf order, folding Arabic hamza forms; false is fuzzy, ranked by relevance, and matches parts of words. With surah, offset still counts matches across the Quran; pages continue at pagination.next_offset (fuzzy scans up to 100 matches per call). Up to 20 ayahs per page, each with reference and text by default; with no total, has_more is true whenever a page is full.
search_words_by_category
ChatGPTFind Quran words with tags of one category, for example all verbs ('Afal'), or with one of its tag codes (for example 'ضي', past tense). Use it to list words of a grammatical kind, such as the verbs of Al-Fatiha. A tag_code of another category matches nothing. Each result has location, text, simple ayah text and matched_tags: codes in concise, with their meanings once in data.tag_meanings; detailed adds surah, ayah number, position and inline meanings. Paged: default 20, at most 50; pagination.total counts the words.
search_words_by_pattern
ChatGPTFind Quran words built on one pattern (wazn), for example 'فَعِيل' (as in rahim). Use it to study a word form. It is matched against Sarf tag meanings: a vowelled wazn matches that pattern tag, while unvowelled 'فاعل' can match a broader one (active participle). data.pattern_info gives the matched tag_code, whose words are returned, and its total_occurrences; list_morphology_tags (category 'Sarf', search 'وزن') lists patterns. Each word appears once (location, text, surah, ayah number, position, simple ayah text). Paged: default 20, at most 50; pagination.total counts the words.
search_words_by_root
ChatGPTFind the Quran's words derived from an Arabic root. Use it to study a root's usage. Spaces, dashes and vowel marks are removed ('ر ح م' and 'رَحِمَ' become 'رحم'); Latin transliterations are refused. Returns root_info (Quran-wide total_occurrences and surahs_count) and derivatives: location, text, surah, ayah number, position and simple ayah text. Paged: default 20, at most 50; pagination.total counts the words.
search_words_by_tags
ChatGPTFind Quran words carrying given morphological tags, for example ['ب', 'جر'] (prefix baa, genitive) or ['ضي'] (past-tense verbs). Use it for grammar questions, such as the past-tense verbs of surah 2. Codes come from list_morphology_tags or a word's analysis; unknown codes match nothing (no error). Each result has location, text, surah, ayah number, position, simple ayah text and matched_tags. Paged: default 20, at most 50; pagination.total counts the words.