Voices & Languages

Before sending requests, it is important to specify the voice and language otherwise the system will try to auto detect the language and use default voice where necessary.

1. Get Languages

Safi supports multiple languages fluently. You can fetch them below and append to any request/response.

GET /language/list

Headers

GET /language/list

{
    "status": "success",
    "data": [
        {
            "name": "arabic",
            "voices": [
                {
                    "id": "safi",
                    "gender": "neutral"
                },
                {
                    "id": "khadi",
                    "gender": "female"
                },
                {
                    "id": "khalid",
                    "gender": "male"
                },
                {
                    "id": "idan",
                    "gender": "male"
                }
            ],
            "listening": true,
            "text": true
        },
        {
            "name": "english",
            "voices": [
                {
                    "id": "safi",
                    "gender": "neutral"
                },
                {
                    "id": "khadi",
                    "gender": "female"
                },
                {
                    "id": "nora",
                    "gender": "female"
                },
                {
                    "id": "tolu",
                    "gender": "female"
                },
                {
                    "id": "khalid",
                    "gender": "male"
                },
                {
                    "id": "uche",
                    "gender": "male"
                },
                {
                    "id": "yemi",
                    "gender": "male"
                },
                {
                    "id": "idan",
                    "gender": "male"
                }
            ],
            "listening": true,
            "text": true
        },
        {
            "name": "french",
            "voices": [
                {
                    "id": "safi",
                    "gender": "neutral"
                },
                {
                    "id": "idan",
                    "gender": "male"
                }
            ],
            "listening": true,
            "text": true
        },
        {
            "name": "hausa",
            "voices": [
                {
                    "id": "safi",
                    "gender": "neutral"
                },
                {
                    "id": "khadi",
                    "gender": "female"
                },
                {
                    "id": "khalid",
                    "gender": "male"
                },
                {
                    "id": "idan",
                    "gender": "male"
                }
            ],
            "listening": true,
            "text": true
        },
        {
            "name": "igbo",
            "voices": [
                {
                    "id": "safi",
                    "gender": "neutral"
                },
                {
                    "id": "nora",
                    "gender": "female"
                },
                {
                    "id": "uche",
                    "gender": "male"
                },
                {
                    "id": "idan",
                    "gender": "male"
                }
            ],
            "listening": true,
            "text": true
        },
        {
            "name": "pidgin",
            "voices": [
                {
                    "id": "safi",
                    "gender": "neutral"
                },
                {
                    "id": "khadi",
                    "gender": "female"
                },
                {
                    "id": "nora",
                    "gender": "female"
                },
                {
                    "id": "tolu",
                    "gender": "female"
                },
                {
                    "id": "khalid",
                    "gender": "male"
                },
                {
                    "id": "uche",
                    "gender": "male"
                },
                {
                    "id": "yemi",
                    "gender": "male"
                },
                {
                    "id": "idan",
                    "gender": "male"
                }
            ],
            "listening": true,
            "text": true
        },
        {
            "name": "yoruba",
            "voices": [
                {
                    "id": "safi",
                    "gender": "neutral"
                },
                {
                    "id": "tolu",
                    "gender": "female"
                },
                {
                    "id": "yemi",
                    "gender": "male"
                },
                {
                    "id": "idan",
                    "gender": "male"
                }
            ],
            "listening": true,
            "text": true
        }
    ],
    "message": "Fetched Account Languages.",
    "code": 0
}

2. Get Voices

By default Safi speaks all its supported languages fluently, however, you should specify voice name if you want to customize or get a specific voice with every request.

Get /voice/list

Headers

Name

Value

Content-Type

application/json

apiKey

string

secret

string

GET /voice/list

"status":"success",
"data": [
    {
        "id": "safi",
        "gender": "neutral"
    },
    {
        "id": "khadi",
        "gender": "female"
    },
    {
        "id": "nora",
        "gender": "female"
    },
    {
        "id": "tolu",
        "gender": "female"
    },
    {
        "id": "khalid",
        "gender": "male"
    },
    {
        "id": "uche",
        "gender": "male"
    },
    {
        "id": "yemi",
        "gender": "male"
    },
    {
        "id": "idan",
        "gender": "male"
    }
    ],
"code":0,
"message":"Fetched voices"

PreviousSDK & Packages NextSimple Messaging

Last updated 7 months ago

Was this helpful?

{ "status": "success", "data": [ { "name": "arabic", "voices": [ { "id": "safi", "gender": "neutral" }, { "id": "khadi", "gender": "female" }, { "id": "khalid", "gender": "male" }, { "id": "idan", "gender": "male" } ], "listening": true, "text": true }, { "name": "english", "voices": [ { "id": "safi", "gender": "neutral" }, { "id": "khadi", "gender": "female" }, { "id": "nora", "gender": "female" }, { "id": "tolu", "gender": "female" }, { "id": "khalid", "gender": "male" }, { "id": "uche", "gender": "male" }, { "id": "yemi", "gender": "male" }, { "id": "idan", "gender": "male" } ], "listening": true, "text": true }, { "name": "french", "voices": [ { "id": "safi", "gender": "neutral" }, { "id": "idan", "gender": "male" } ], "listening": true, "text": true }, { "name": "hausa", "voices": [ { "id": "safi", "gender": "neutral" }, { "id": "khadi", "gender": "female" }, { "id": "khalid", "gender": "male" }, { "id": "idan", "gender": "male" } ], "listening": true, "text": true }, { "name": "igbo", "voices": [ { "id": "safi", "gender": "neutral" }, { "id": "nora", "gender": "female" }, { "id": "uche", "gender": "male" }, { "id": "idan", "gender": "male" } ], "listening": true, "text": true }, { "name": "pidgin", "voices": [ { "id": "safi", "gender": "neutral" }, { "id": "khadi", "gender": "female" }, { "id": "nora", "gender": "female" }, { "id": "tolu", "gender": "female" }, { "id": "khalid", "gender": "male" }, { "id": "uche", "gender": "male" }, { "id": "yemi", "gender": "male" }, { "id": "idan", "gender": "male" } ], "listening": true, "text": true }, { "name": "yoruba", "voices": [ { "id": "safi", "gender": "neutral" }, { "id": "tolu", "gender": "female" }, { "id": "yemi", "gender": "male" }, { "id": "idan", "gender": "male" } ], "listening": true, "text": true } ], "message": "Fetched Account Languages.", "code": 0 }

"status":"success", "data": [ { "id": "safi", "gender": "neutral" }, { "id": "khadi", "gender": "female" }, { "id": "nora", "gender": "female" }, { "id": "tolu", "gender": "female" }, { "id": "khalid", "gender": "male" }, { "id": "uche", "gender": "male" }, { "id": "yemi", "gender": "male" }, { "id": "idan", "gender": "male" } ], "code":0, "message":"Fetched voices"