Frequently Asked Questions
Weโve compiled frequently asked questions and their answers during API usage.
Weโve organized the most frequently asked questions by topic, from those first using the API to users who have integrated cloned voices.
1. Get Started with API
Where can I get an API Key?
Where can I get an API Key?
You can get it immediately by signing up for the service in the console. You can use up to 3 Keys per account, and revocation and reissuance are possible in case of leakage.
How do I integrate the API?
How do I integrate the API?
When making HTTP requests, put the issued Key in the x-sup-api-key
header. For detailed integration methods, please refer to Quick Start.
Do I need to use a different account from Play?
Do I need to use a different account from Play?
No. Play and API operate on the same account basis.
2. Voice & API Calls
Where can I check available voice IDs?
Where can I check available voice IDs?
Voice IDs can be checked through the following three methods:
- Copy from the voice library in Supertone Play
- Call GET /v1/voices endpoint for complete inquiry
- Call GET /v1/voices/search endpoint for conditional search For more details, please check the Voice Selection Guide.
Can I use cloned voices in the API?
Can I use cloned voices in the API?
Yes. Cloned voices created in Play can also be called in the API with the same account. Cloned voice creation is only possible in Play.
How can I find the ID of a cloned voice?
How can I find the ID of a cloned voice?
By searching with GET /v1/voices/search?name=My Voice
, you can filter and check only cloned voices created within your account.
For more details, please check the Voice Selection Guide.
Can I make calls just knowing the voice ID?
Can I make calls just knowing the voice ID?
No. In addition to voice_id
, the language
, style
, and model
combination must match exactly for voice to be generated normally.
What combinations are possible for each voice?
What combinations are possible for each voice?
Through the samples
field, you can check supported language/style/model combinations and sample audio for each voice.
For more details, please check the Voice Selection Guide.
Is the style parameter required?
Is the style parameter required?
No. Style is optional, and the systemโs default style is automatically applied if not provided.
Can I adjust voice speed or pitch?
Can I adjust voice speed or pitch?
You can adjust pitch_shift
, pitch_variance
, and speed
through voice_settings
.
What is the Predict Duration API for?
What is the Predict Duration API for?
Itโs a feature that predicts the speech length of input text. Credits are not deducted.
3. Credit & Pricing
What is the API pricing plan?
What is the API pricing plan?
It uses the same credit system as Play. Please check available plans on the Play subscription page.
How can I check my credit balance?
How can I check my credit balance?
You can check through the following two methods:
- Call
GET /v1/credits
API - Check console or Play dashboard
Are credits only deducted from the API?
Are credits only deducted from the API?
No. Play and API share the same credits.
Can I use voices created in Play in the API?
Can I use voices created in Play in the API?
Yes. Cloned voices created within the same account can be called in the API without additional settings.
4. Errors & Troubleshooting
What are the most common errors when making calls?
What are the most common errors when making calls?
- 401: API Key error
- 402: Insufficient credits
- 403: Unauthorized voice call
- 400: Parameter error, text overflow, etc.
- 429: Call limit exceeded For more details, please check the Error Handling guide.
Where can I check error codes?
Where can I check error codes?
You can check them in the Error Handling guide.
My calls keep failing.
My calls keep failing.
Please refer to the Error Handling guide and check the following:
- Verify that x-sup-api-key is included in headers
- Check if Content-Type: application/json is missing
- Verify that voice_id has been replaced with actual value If problems persist, please contact through the customer support page.
What are the call frequency limits?
What are the call frequency limits?
We recommend 20 calls or fewer per minute by default. For higher traffic needs, separate inquiry is required.
๐ข Enterprise Inquiry
5. Operational Policy & Support
Can anyone use the API?
Can anyone use the API?
Yes. You can use it immediately after signing up for the console and charging credits, with no separate approval required.
Is there an enterprise plan?
Is there an enterprise plan?
Yes. For team-level usage, user account separation, call limit expansion, and other special conditions, please contact through support.
๐ข Enterprise Inquiry
Where do I contact if problems aren't resolved?
Where do I contact if problems aren't resolved?
Please leave a 1:1 inquiry through the customer support page, and weโll respond quickly.