Farsava API
1.0.7

Farsava API. Speech Recognition and Text to Speech by applying powerful deep neural network models.

This is the documentation for version 1.0.7 of the API. Last update on Jul 7, 2019.

Base URL 
https://api.amerandish.com/v1

GET /voice/speakers

GET /voice/speakers
Bearer auth

This endpoint retrieves the list of available speakers for speech synthesization. Each speaker has a unique voiceId which can be used to synthesize speech. The result aslo includes each speaker langauge, gender and name.

Responses

  • • 200

    OK. TTS Voices List Retrieved.

    Hide response attributes Show response attributes array[object]
    • voiceId string(uuid) Required

      id of the desired voice to synthesize.

    • languageCode string

      The language of the supplied audio as a language tag. Example en for english language. See Language Support for a list of the currently supported language codes.

      Values are fa or en.

    • name string

      Name of the desired voice.

    • gender string

      The gender of the requested voice to synthesize.

      Values are male or female. Default value is female.
  • • 400

    This response means that server could not understand the request due to invalid syntax.

    Hide response attributes Show response attributes object
    • status string Required

      HTTP response status code.

    • detail string Required

      Message explaining the issue.

    • title string

      Error message title.

    • type string

      Error type.
  • • 401

    Authentication is needed to get requested response. This is similar to 403, but in this case, authentication is possible.

    Hide response attributes Show response attributes object
    • status string Required

      HTTP response status code.

    • detail string Required

      Message explaining the issue.

    • title string

      Error message title.

    • type string

      Error type.
  • • 403

    Client does not have access rights to the content so server is rejecting to give proper response.

    Hide response attributes Show response attributes object
    • status string Required

      HTTP response status code.

    • detail string Required

      Message explaining the issue.

    • title string

      Error message title.

    • type string

      Error type.
  • • 405

    The request method is known by the server but has been disabled and cannot be used.

    Hide response attributes Show response attributes object
    • status string Required

      HTTP response status code.

    • detail string Required

      Message explaining the issue.

    • title string

      Error message title.

    • type string

      Error type.
  • • 429

    The user has sent too many requests in a given amount of time ("rate limiting").

    Hide response attributes Show response attributes object
    • status string Required

      HTTP response status code.

    • detail string Required

      Message explaining the issue.

    • title string

      Error message title.

    • type string

      Error type.
  • • 500

    The server has encountered a situation it doesn't know how to handle.

    Hide response attributes Show response attributes object
    • status string Required

      HTTP response status code.

    • detail string Required

      Message explaining the issue.

    • title string

      Error message title.

    • type string

      Error type.
  • • 501

    The request method is not supported by the server and cannot be handled.

    Hide response attributes Show response attributes object
    • status string Required

      HTTP response status code.

    • detail string Required

      Message explaining the issue.

    • title string

      Error message title.

    • type string

      Error type.
GET /voice/speakers 
curl \
 -X GET https://api.amerandish.com/v1/voice/speakers \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "languageCode": "fa",
    "voiceId": "b6e9c993-729e-4e0f-955b-f229cf1f77ee",
    "name": "speaker-01",
    "gender": "female"
  },
  {
    "languageCode": "fa",
    "voiceId": "225fcaf8-fdcc-4fea-ab47-a168b3093e17",
    "name": "speaker-02",
    "gender": "female"
  },
  {
    "languageCode": "fa",
    "voiceId": "7bfc7800-881b-4b39-b975-3ed024ae2f9f",
    "name": "speaker-03",
    "gender": "male"
  },
  {
    "languageCode": "en",
    "voiceId": "79554d08-bc00-4358-9ff7-8d12335cf9cb",
    "name": "speaker-11",
    "gender": "female"
  },
  {
    "languageCode": "en",
    "voiceId": "2079a911-5f7b-49f4-89a9-b6d2d44666ed",
    "name": "speaker-12",
    "gender": "male"
  }
]
Response examples (400) 
{
  "code": 400,
  "message": "Bad Request. Invalid JSON object."
}
Response examples (401) 
{
  "code": 401,
  "message": "Unautherized. Invalid Authorization Token."
}
Response examples (403) 
{
  "code": 403,
  "message": "Forbidden. Do not have access right to resource."
}
Response examples (405) 
{
  "code": 405,
  "message": "Method Not Allowed."
}
Response examples (429) 
{
  "code": 429,
  "message": "Too Many Requests. Your request is blocked due to exceeding rate limiting."
}
Response examples (500) 
{
  "code": 500,
  "message": "Internal Server Error. Please retry later."
}
Response examples (501) 
{
  "code": 501,
  "message": "Not Implemented. This functionality is not implemented yet."
}