/
GA
ganjoor
/
RMuseum API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 12h ago · Updated 6d ago
View markdown
ganjoor
RMuseum API
post
start exporting all published Ganjoor data to the public git-tracked JSON data set (Auth policies: ganjoor:import)
OpenAPI 3.0.4
2026-08-14
481
162
870.6 KB
64a5b49a158a
AppUser
32
Artifact
86
AuditLog
1
ContributionStats
4
DonationAccounting
13
ExternalFTP
3
FAQ
14
Ganjoor
208
get
get list of published poets without their biography
get
gets list of poets grouped by centuries (first one is the pinned ones)
get
get list of all poets (including unpublished ones) with their bio (Auth policies: ganjoor:modify)
get
poet by id
put
update poet info (except for image) (Auth policies: ganjoor:modify)
delete
starts deleting poet job ` (Auth policies: ganjoor:modify)
get
poet by url
post
create new poet (Auth policies: ganjoor:modify)
post
regenerate half centuries (Auth policies: ganjoor:modify)
get
get poet image with png ext
get
get poet image
post
set poet image (Auth policies: ganjoor:modify)
get
cat by id
delete
delete a category (Auth policies: ganjoor:modify)
get
cat by full url
put
set category extra info (Auth policies: ganjoor:modify)
put
generate missing book covers (Auth policies: ganjoor:modify)
get
list of books
put
batch rename cat poems (Auth policies: ganjoor:modify)
put
batch resulg category poems (Auth policies: ganjoor:modify)
put
(Auth policies: ganjoor:modify)
put
set category poems language tag (Auth policies: ganjoor:modify)
put
set category poems language tag (Auth policies: ganjoor:modify)
put
fill missing poem formats (Auth policies: ganjoor:modify)
put
start assigning poem rhythms (Auth policies: ganjoor:modify)
post
Start Finding Missing Rhythms (Auth policies: ganjoor:modify)
get
generate category toc (Auth policies: ganjoor:modify)
put
directly insert generated TOC (Auth policies: ganjoor:modify)
put
start generating sub cats TOC (Auth policies: ganjoor:modify)
put
regenerate TOCs (Auth policies: ganjoor:modify)
get
page by url
post
add new page (Auth policies: ganjoor:modify)
put
modify page (Auth policies: ganjoor:modify)
delete
delete page (Auth policies: ganjoor:modify)
put
modify poem => only these fields: NoIndex, RedirectFromFullUrl, MixedModeOrder (Auth policies: ganjoor:modify)
delete
clean cache by id (Auth policies: ganjoor:modify)
get
older versions of a page (modifications history except for current version) (Auth policies: ganjoor:modify)
get
get old version of page (Auth policies: ganjoor:modify)
get
page url by id
get
get redirect url for a url
get
get poem by id
delete
delete a poem (Auth policies: ganjoor:modify)
get
get poem verses by id
get
get poem by url
get
get poem recitations (PlainText/HtmlText are intentionally empty)
get
get user upvoted recitations of a poem (Auth)
get
get poem images (PlainText/HtmlText are intentionally empty)
get
get poem songs
get
Get Poem Comments
post
Rate a comment (like / dislike / clear rating) (Auth)
get
get the logged on user's own rating values for a poem's comments (meant to be merged client-side into an already fetched, anonymously cacheable comment list) (Auth)
get
Get Section Related ones
get
find poem section rhyming letters
delete
delete a poem section (section should not be linked to a poem verse of types other than paragraphs or comments) (Auth policies: ganjoor:modify)
post
send poem corrections (Auth)
delete
delete unreviewed user corrections for a poem (Auth)
get
returns last unreviewed correction from the user for a poem (Auth)
get
get list of user suggested corrections (Auth)
get
get list of all suggested corrections (Auth policies: ganjoor:modify)
get
effective corrections for poem
get
get correction by id (Auth policies: ganjoor:modify)
get
get next unreviewed correction (Auth policies: ganjoor:modify)
post
moderate poem correction (Auth policies: ganjoor:modify)
post
break a poem from a verse forward (Auth policies: ganjoor:modify)
get
get next unreviewed song (Auth)
put
review song (Auth policies: ganjoor:songrevu)
post
suggest song for poem (Auth)
delete
delete a poem song by id (Auth policies: ganjoor:songrevu)
get
get song by id (Auth policies: ganjoor:songrevu)
get
history of suggested songs by a user (Auth policies: ganjoor:songrevu)
get
user suggested songs (Auth)
put
modify a published song (Auth policies: ganjoor:songrevu)
post
directly insert a poem related song (Auth policies: ganjoor:songadd)
get
get a random poem from hafez
get
get a random poem from a poet (c.ganjoor.net replacement), 0 means random poet, حافظ (2)، خیام (3)، ابوسعید ابوالخیر (26)، صائب (22)، سعدی (7)، باباطاهر (28)، مولوی (5)، اوحدی (19)، خواجو (20)، شهریار (35)، عراقی (21)، فروغی بسطامی (32)، سلمان ساوجی (40)، محتشم کاشانی (29)، امیرخسرو دهلوی (34)، سیف فرغانی (31)، عبید زاکانی (33)، هاتف اصفهانی (25) یا رهی معیری (41)
get
get a single comment information (only published comments, replies are not included)
get
get recent comments
get
get logged on users recent comments (Auth)
get
get awaiting comments (Auth policies: ganjoor:moderate)
delete
delete awaiting comment (Auth policies: ganjoor:moderate)
put
publish awaiting comment (Auth policies: ganjoor:moderate)
post
post new comment (Auth)
delete
delete user's own comment (Auth)
put
edit user's own comment (Auth)
put
link or unlink user's own comment to a coupletIndex (Auth)
post
report a comment (Auth)
delete
delete a report (without deleting corresponding comment) (Auth policies: ganjoor:moderate)
get
get list of reported comments (Auth policies: ganjoor:moderate)
delete
delete reported other users comment (Auth policies: ganjoor:moderate)
post
imports data from ganjoor SQLite database (form file) (Auth policies: ganjoor:import)
post
import category data from ganjoor SQLite database (form file) (Auth policies: ganjoor:import)
post
Apply corrections from sqlite (Auth policies: ganjoor:import)
get
export a poet to sqlite database (Auth policies: ganjoor:import)
post
start exporting all poets (Auth policies: ganjoor:songrevu)
post
start exporting all published Ganjoor data to the public git-tracked JSON data set (Auth policies: ganjoor:import)
post
(Auth policies: ganjoor:import)
get
Get user public profile
get
Get Similar Poems accroding to prosody and rhyme informations
get
language tagged poem sections
get
search
get
returns ganjoor metre list ordered by rhythm
get
find poem rhyme
get
analysis poem to find its prosody information
post
examine site pages for broken links (Auth policies: ganjoor:import)
post
examine comments for long links (Auth policies: ganjoor:import)
post
start filling poems couplet indices (Auth policies: ganjoor:import)
post
refill couplet indices for poem (Auth policies: ganjoor:import)
post
fill section couplet counts (Auth policies: ganjoor:import)
post
regenerate poem full titles to fix an old bug (Auth policies: ganjoor:import)
post
start finding rhymes (Auth policies: ganjoor:import)
post
separate verses in poem.PlainText with Environment.NewLine instead of SPACE (Auth policies: ganjoor:import)
post
start building sitemap (Auth policies: ganjoor:modify)
post
build tj.ganjoor.net site map (Auth policies: ganjoor:modify)
put
regenerate stats page (Auth policies: ganjoor:modify)
put
start updating mundex page (Auth policies: ganjoor:songrevu)
post
switch bookmark (Auth)
post
switch bookmark and return bookmark id ('0' for switching off a bookmark) (Auth)
get
is the poem couplet is bookmarked by user (Auth)
post
Bookmark couplet if it is not (Auth)
put
modify bookmark private note (Auth)
delete
delete bookmark (Auth)
get
get poem user bookmarks (only Id, CoupletIndex and DateTime are valid in the output view model) (Auth)
get
user bookmarks (Auth)
post
start generating related sections info for wholepoem sections (Auth policies: ganjoor:import)
get
get next ganjoor poem probable metre
get
get a list of ganjoor poems probable metres
put
save ganjoor poem probable metre (Auth policies: ganjoor:modify)
delete
dismiss ganjoor poem probable metre (Auth policies: ganjoor:modify)
post
Finding Category Poems Duplicates (Auth policies: ganjoor:modify)
post
manually add a duplicate for a poems (Auth policies: ganjoor:modify)
delete
delete a duplicate (Auth policies: ganjoor:modify)
get
list of category saved duplicated poems (Auth policies: ganjoor:modify)
put
start removing category duplicates (Auth policies: ganjoor:modify)
get
get couplet sections
get
get all poem sections
post
regenerate poem sections (dangerous: wipes out existing data) (Auth policies: ganjoor:modify)
post
update related sections manually (Auth policies: ganjoor:modify)
put
regenerate category related sections (Auth policies: ganjoor:modify)
get
get a specific poem section
post
start band couplets fix (Auth policies: ganjoor:modify)
get
returns last unreviewed correction from the user for a section (Auth)
post
send a correction for a section (Auth)
post
moderate poem section correction (Auth policies: ganjoor:modify)
get
get section correction by id (Auth policies: ganjoor:modify)
delete
delete unreviewed user corrections for a poem section (Auth)
get
get next unreviewed correction for poem sections (Auth policies: ganjoor:modify)
get
get list of user suggested corrections (Auth)
get
get list of all suggested corrections (Auth policies: ganjoor:modify)
get
effective corrections for section
put
transfer poems and sections from a meter to another one and delete the source meter (Auth policies: ganjoor:modify)
get
get poem tags ordered by LunarDateTotalNumber then by Id
put
update poem tag (Auth policies: ganjoor:modify)
post
add poem geo tag (Auth policies: ganjoor:modify)
delete
delete poem tag (Auth policies: ganjoor:modify)
get
get a categoty poem tags
put
(Auth policies: ganjoor:moderate)
post
synchronize https:://naskban.ir links (logs in and then out to naskban.ir using auth info) (Auth policies: ganjoor:moderate)
delete
delete poem related naskban images by url (Auth policies: ganjoor:modify)
put
mark naskban links for poems of a categiory and its children as human reviewed (Auth policies: ganjoor:moderate)
put
mark naskban links a text original for a category (Auth policies: ganjoor:moderate)
put
import naskban ganjoor matchings (Auth policies: ganjoor:moderate)
put
discover poet naskban paper sources (Auth policies: ganjoor:moderate)
put
import paper sources from museum (Auth policies: ganjoor:moderate)
get
get paper sources for a catgeory
get
get category poem related images
post
extracting quoted poems (Auth policies: ganjoor:modify)
put
regenerate related poems pages (Auth policies: ganjoor:modify)
put
regenerate two poets similar page (Auth policies: ganjoor:modify)
post
discover related poems (Auth policies: ganjoor:modify)
get
get quoted poems for a poem
get
two poems quoted records
get
get quoted poems
put
update quoted (Auth policies: ganjoor:modify)
post
insert quoted (Auth policies: ganjoor:modify)
delete
delete quoted (Auth policies: ganjoor:modify)
get
get quoted by id
get
get list of user suggested corrections (Auth)
post
suggest new quote (for normal users) (Auth)
get
next unmoderated quoted poem (Auth policies: ganjoor:modify)
put
moderate quoted poems (Auth policies: ganjoor:modify)
get
digital source from tag
put
tag category with source (Auth policies: ganjoor:modify)
post
update digital sources stats (Auth policies: ganjoor:modify)
post
build word counts (Auth policies: ganjoor:modify)
put
one time fixer for word counts new RowNmbrInCat fields (Auth policies: ganjoor:modify)
put
one time fixer for category word count summries (Auth policies: ganjoor:modify)
get
category word counts
get
category words summary
get
comparison of word counts for poets
get
CategoryWordCount for a specific term in a category
put
(Auth policies: ganjoor:import)
put
re-runs the Tajik poet/category HTML generators for every already-imported poet and category page, overwriting their stored TajikHtmlText. Needed one-time after changing either generator function (e.g. adding poem excerpts to the table of contents), since the normal SQLite import skips pages that already exist and never refreshes them. Runs as a background job - check the Admin area's LongRunningJobs page for progress. (Auth policies: ganjoor:import)
put
recovery job: regenerates TajikHtmlText for Tajik poems whose stored HTML currently contains a link (the signature left by the CatPage id corruption bug) - use after RegenerateTajikCatAndPoetHtmlText (or anything else) may have corrupted poem pages. Check the Admin area's LongRunningJobs page for progress. (Auth policies: ganjoor:import)
get
tajik poets
get
tajik page by url
get
search tajik poems
put
fill couplet summaries using open ai (Auth policies: ganjoor:modify)
put
fill poem summaries using open ai (Auth policies: ganjoor:modify)
put
geo tag poems using AI (Auth policies: ganjoor:modify)
post
send cat corrections (Auth)
get
get cat correction by id (Auth policies: ganjoor:modify)
delete
delete unreviewed user cat corrections for a poem (Auth)
get
returns last unreviewed correction from the user for a cat (Auth)
get
get list of user suggested cat corrections (Auth)
get
get list of all suggested cat corrections (Auth policies: ganjoor:modify)
get
effective corrections for a cat
get
get next unreviewed cat correction (Auth policies: ganjoor:modify)
post
moderate cat correction (Auth policies: ganjoor:modify)
GanjoorPoetSuggestedPhotos
7
GanjoorPoetSuggestedSpecLines
7
GeoLocation
5
Image
5
MusicCatalogue
2
Notification
10
Numbering
9
Recitation
40
RGenericOptions
8
RImage
2
RLongRunningJobs
3
Role
8
SiteBanners
5
Translation
5
UserVisitsTracking
4
Ganjoor
start exporting all published Ganjoor data to the public git-tracked JSON data set (Auth policies: ganjoor:import)
post
/api/ganjoor/publicdata/batchexport
Response
OK