| description |
content |
Successful response |
| application/json |
| schema |
example |
| required |
type |
properties |
|
object |
| audio_files |
| type |
items |
array |
| title |
type |
properties |
example |
required |
Chapter Recitation |
object |
| id |
chapter_id |
file_size |
format |
audio_url |
| type |
description |
integer |
The Id of the audio file |
|
| type |
description |
integer |
The chapter id |
|
| type |
description |
integer |
The file size in bytes |
|
| type |
description |
string |
The format of the file |
|
| type |
description |
string |
The audio file's url |
|
|
| id |
chapter_id |
file_size |
format |
audio_url |
1 |
1 |
710784 |
mp3 |
|
|
id |
chapter_id |
file_size |
format |
audio_url |
|
|
|
|
|
| audio_files |
| id |
chapter_id |
file_size |
format |
audio_url |
43 |
22 |
19779712 |
mp3 |
|
|
| id |
chapter_id |
file_size |
format |
audio_url |
87 |
44 |
6453376 |
mp3 |
|
|
|
|
|
|
|
| description |
content |
Will be returned when the request is invalid e.g. request is missing required headers or with invalid query parameters. |
| application/json |
| schema |
example |
| title |
type |
properties |
invalidRequestResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The request is missing required headers or is invalid |
invalid_request |
false |
|
|
|
|
| description |
content |
Will be returned when the request is unauthorized. |
| application/json |
| schema |
example |
| title |
type |
properties |
unauthorizedResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The request requires user authentication |
unauthorized |
false |
|
|
|
|
| description |
content |
Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions. |
| application/json |
| schema |
example |
| title |
type |
properties |
forbiddenResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The server understood the request, but refuses to authorize it |
forbidden |
false |
|
|
|
|
| description |
content |
Not Found. The resource being accessed does not exist. |
| application/json |
| schema |
example |
| title |
type |
properties |
notFoundResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The requested resource could not be found |
not_found |
false |
|
|
|
|
| description |
content |
Validation Error. The request includes one or more invalid params. Please check the request params and try again. |
| application/json |
| schema |
example |
| title |
type |
properties |
unprocessableEntityResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The request was well-formed but was unable to be followed due to semantic errors |
unprocessable_entity |
false |
|
|
|
|
| description |
content |
Rate-limit exceeded |
| application/json |
| schema |
example |
| title |
type |
properties |
rateLimitExceededResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
Too many requests, please try again later |
rate_limit_exceeded |
false |
|
|
|
|
| description |
content |
Server Error. Something went wrong, try again later. |
| application/json |
| schema |
example |
| title |
type |
properties |
internalServerErrorResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The server encountered an internal error and was unable to complete your request |
internal_server_error |
false |
|
|
|
|
| description |
content |
Bad Gateway |
| application/json |
| schema |
example |
| title |
type |
properties |
badGatewayResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The server was acting as a gateway or proxy and received an invalid response from the upstream server |
bad_gateway |
false |
|
|
|
|
| description |
content |
Service Unavailable |
| application/json |
| schema |
example |
| title |
type |
properties |
serviceUnavailableResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The server is currently unable to handle the request due to a temporary overload or scheduled maintenance |
service_unavailable |
false |
|
|
|
|
| description |
content |
Gateway Timeout |
| application/json |
| schema |
example |
| title |
type |
properties |
gatewayTimeoutResponse |
object |
| message |
type |
success |
|
| type |
enum |
string |
gateway_timeout |
service_unavailable |
bad_gateway |
internal_server_error |
unprocessable_entity |
not_found |
forbidden |
unauthorized |
invalid_request |
invalid_token |
insufficient_scope |
service_error |
invalid_path |
rate_limit_exceeded |
|
|
|
|
|
| message |
type |
success |
The server was acting as a gateway or proxy and did not receive a timely response from the upstream server |
gateway_timeout |
false |
|
|
|
|