Recitation

Add a narration profile (Auth)

Changed on Oct 16, 2026

post/api/audio/profile

Request

Base URL
https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization

Request body

idstring uuid

Id

userIdstring uuid

UserId

namestring nullable

Profile Name

fileSuffixWithoutDashstring nullable

this would be appended to audio files names prefixed by a dash to make them unique and specfic to user filenames usually would look like {GanjoorPostId}-{FileSuffixWithoutDash}.{ext} for example 2200-hrm.xml

update [4/10/2021]: you can send this one empty

artistNamestring nullable

artist name

artistUrlstring nullable

artist url

audioSrcstring nullable

audio src

audioSrcUrlstring nullable

audio src url

isDefaultboolean

is default

Example request

{
  "user": {
    "username": "test",
    "email": "email@domain.com",
    "phoneNumber": "+989121234567",
    "firstName": "Hamid Reza",
    "surName": "Mohammadi"
  }
}

Response

OK

idstring uuid

Id

userIdstring uuid

UserId

namestring nullable

Profile Name

fileSuffixWithoutDashstring nullable

this would be appended to audio files names prefixed by a dash to make them unique and specfic to user filenames usually would look like {GanjoorPostId}-{FileSuffixWithoutDash}.{ext} for example 2200-hrm.xml

update [4/10/2021]: you can send this one empty

artistNamestring nullable

artist name

artistUrlstring nullable

artist url

audioSrcstring nullable

audio src

audioSrcUrlstring nullable

audio src url

isDefaultboolean

is default

Example response

{
  "user": {
    "username": "test",
    "email": "email@domain.com",
    "phoneNumber": "+989121234567",
    "firstName": "Hamid Reza",
    "surName": "Mohammadi"
  }
}

Changes

Oct 16, 2026493e82d8a523 Revision changes
- info
  added the new optional request property / (media type: application/json)
- info
  added the new optional request property / (media type: text/json)
- info
  added the new optional request property / (media type: application/*+json)
- info
  added the new optional request property / (media type: application/json)
- info
  added the new optional request property / (media type: text/json)
- info
  added the new optional request property / (media type: application/*+json)
- info
  added the new optional request property / (media type: application/json)
- info
  added the new optional request property / (media type: text/json)
- info
  added the new optional request property / (media type: application/*+json)
- info
  added the new optional request property / (media type: application/json)
- info
  added the new optional request property / (media type: text/json)
- info
  added the new optional request property / (media type: application/*+json)
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status

Operation history