Get User Info

This endpoint gets or creates a new user.

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.

Response

code · number

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

plan · string

Your current subscription plan.

status · string

Your current subscription status:

If you haven’t cancel your subsciption, the status will be “active”,

If you have cancelled your subcription, the status will be “cancellation upon expiration” before the subscription expired.

resetInDays · number

If you haven’t cancelled your subscription, this parameter means the countdown days for your plan benefits to be updated.

If you have cancelled your subscription, this parameter means the countdown days for your plan to be downgraded to a free user.

benefit · object

Show Toggle object

usedVoices · number

The number of custom voices you created through the website or API.

totalVoices · number

The maximum number of custom voices you can create with your subscription plan.

usedMonthlyChars · number

The number of TTS characters you have used within your subscription plan.

totalMonthlyChars · number

The maximum number of TTS characters within your subscription plan.

usedOrderChars · number

The number of TTS characters you have used without your subscription plan.

totalOrderChars · number

The number of TTS characters you have purchased without your subscription plan.

Example Request

curl --location 'https://api.myvocal.ai/sound_clone/api/v1/user/info' \
--header 'accessKey: xxxx'

200（success）

{
    "code": 1,
    "message": "Success",
    "data": {
        "plan": "Business",
        "status": "active",
        "resetInDays": 2,
        "benefit": {
            "usedVoices": 146,
            "totalVoices": 150,
            "usedMonthlyChars": 3498604,
            "totalMonthlyChars": 3500000,
            "usedOrderChars": 0,
            "totalOrderChars": 0
        }
    }
}