Get TTS List

Return metadata about all your generated tts audio.

GET /sound_clone/api/v1/tts/list

Example Request

curl --location 'https://api.myvocal.ai/sound_clone/api/v1/tts/list' \
--header 'accessKey: xxx'

200（success）

{
    "code": 1,
    "message": "Success",
    "data": {
        "hasMore": true,
        "earliestHistoryItemId": "2186",
        "list": [
            {
                "voiceId": "7813",
                "voiceName": "test",
                "id": "2197",
                "title": "female",
                "text": "Generate a text-to-speech audio using a voice of your choice and returns audio stream.",
                "useChars": 86,
                "language": "en",
                "channel": "api"
            },
            {
                "voiceId": "7789",
                "voiceName": "FirstClonedVoice",
                "id": "2194",
                "title": "female",
                "text": "Generate a text-to-speech audio using a voice of your choice and returns audio stream.",
                "useChars": 86,
                "language": "en",
                "channel": "api"
            }
        ]
    }
}

Header

accessKey · string · required

You can copy your api-key on https://www.myvocal.ai/profile after you have subscribed to Pro or Business Plan.

Body

limit · number · default: "10"

The number of TTS History queries at one time, supporting 10 ~ 1000 data queries at a time.

If this parameter is empty, the default value is 10.

startBeforeTTSId · string

If this parameter is provided, we will start tracing back to earlier TTS History from this TTS item.

If this parameter is empty, then we will default to tracing back directly from the most recent data.

Response

code · number · required

Indicates whether the call was successful. 1 if successful.

message · string

When an exception occurs, specific exception information will be provided in the message.

data · object

Includes specific data.

Show Toggle object

hasMore · boolean

If there is no earlier created TTS item, then callback 1

If there are still earlier created TTS items, then callback 0

earliestHistoryItemId · String

The earliest ttsid in this callback.

list · list

The specific info of TTS history queried this time.

Show Toggle object

id · string

tts id

title · string

tts title

text · string

tts content

useChars · number

character count of this TTS item.

language · string

chosen language

channel · string

web or api

voiceId · string

The voiceid of the voice used to generate this TTS

voiceName · string

TThe voicename of the voice used to generate this TTS.

Example Request

curl --location 'https://api.myvocal.ai/sound_clone/api/v1/tts/list' \
--header 'accessKey: xxx'

200（success）

{
    "code": 1,
    "message": "Success",
    "data": {
        "hasMore": true,
        "earliestHistoryItemId": "2186",
        "list": [
            {
                "voiceId": "7813",
                "voiceName": "test",
                "id": "2197",
                "title": "female",
                "text": "Generate a text-to-speech audio using a voice of your choice and returns audio stream.",
                "useChars": 86,
                "language": "en",
                "channel": "api"
            },
            {
                "voiceId": "7789",
                "voiceName": "FirstClonedVoice",
                "id": "2194",
                "title": "female",
                "text": "Generate a text-to-speech audio using a voice of your choice and returns audio stream.",
                "useChars": 86,
                "language": "en",
                "channel": "api"
            }
        ]
    }
}