curl --request POST 'https://api.voicecheap.ai/v1/actions/settings_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/settings_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/settings_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"companyName": "Studio",
"brandVocabulary": [
"VoiceCheap"
],
"customTranslationInstructions": "Keep product names unchanged.",
"canEditSharedSettings": true,
"favoriteTemplates": {
"dynamicSubtitles": null,
"voiceIds": []
},
"targetLanguagePresets": [
{
"id": "european_languages",
"name": "European languages",
"languages": [
"french",
"german"
]
}
],
"socialMediaStatsPresets": [],
"textToSpeechBrandPresets": [],
"defaultVoiceCloningSettings": {
"stability": 0.5,
"similarity": 0.75
},
"isSoundNotificationsEnabled": true,
"isVoiceCloningSettingsTipDismissed": false
}
}
Paramètres et notifications
Consulter les paramètres du compte
Consultez le vocabulaire enregistré, les instructions de traduction, les préréglages de voix et de langues, les modèles favoris et les préférences personnelles d’interface.
POST
/
v1
/
actions
/
settings_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/settings_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/settings_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/settings_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"companyName": "Studio",
"brandVocabulary": [
"VoiceCheap"
],
"customTranslationInstructions": "Keep product names unchanged.",
"canEditSharedSettings": true,
"favoriteTemplates": {
"dynamicSubtitles": null,
"voiceIds": []
},
"targetLanguagePresets": [
{
"id": "european_languages",
"name": "European languages",
"languages": [
"french",
"german"
]
}
],
"socialMediaStatsPresets": [],
"textToSpeechBrandPresets": [],
"defaultVoiceCloningSettings": {
"stability": 0.5,
"similarity": 0.75
},
"isSoundNotificationsEnabled": true,
"isVoiceCloningSettingsTipDismissed": false
}
}
Consultez le vocabulaire enregistré, les instructions de traduction, les préréglages de voix et de langues, les modèles favoris et les préférences personnelles d’interface.
Autorisations requises:
POST https://api.voicecheap.ai/v1/actions/settings_get
Authentification et autorisations
string
requis
Envoyez une clé API VoiceCheap dans cet en-tête. Authorization: Bearer avec la même clé API est également accepté. Les jetons d’accès OAuth sont
acceptés uniquement par MCP, pas par cet endpoint REST.
settings:read.
Un abonnement payant actif est requis. Les autorisations ne modifient ni les rôles dans l’équipe, ni la propriété des ressources, ni les crédits média, ni les limites du forfait.
Paramètres
Envoyez un objet JSON vide. Cette action ne comporte aucun champ d’entrée.Schéma d’entrée complet
Schéma d’entrée complet
Le JSON Schema ci-dessous conserve les noms de champs exacts, les types imbriqués, les valeurs par défaut, les limites et les valeurs acceptées exposés par la découverte. Les règles supplémentaires entre champs figurent dans les notes de l’opération.
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Exemples de requêtes
Remplacez les exemples d’identifiants de ressources et de clés média par des valeurs renvoyées pour votre compte. Conservez le même identifiant de requête lorsque vous réessayez la même mutation.curl --request POST 'https://api.voicecheap.ai/v1/actions/settings_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/settings_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/settings_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Réponse
Une première exécution réussie renvoie HTTP 200 avec le résultat de l’opération sous data. Une nouvelle tentative peut renvoyer à la place l’état de la requête enregistrée. L’exemple présente une réponse possible, sans tous les champs facultatifs. Renvoie les préférences personnelles de l’appelant ainsi que le vocabulaire partagé et les consignes de traduction du propriétaire de l’espace de travail actif.{
"data": {
"companyName": "Studio",
"brandVocabulary": [
"VoiceCheap"
],
"customTranslationInstructions": "Keep product names unchanged.",
"canEditSharedSettings": true,
"favoriteTemplates": {
"dynamicSubtitles": null,
"voiceIds": []
},
"targetLanguagePresets": [
{
"id": "european_languages",
"name": "European languages",
"languages": [
"french",
"german"
]
}
],
"socialMediaStatsPresets": [],
"textToSpeechBrandPresets": [],
"defaultVoiceCloningSettings": {
"stability": 0.5,
"similarity": 0.75
},
"isSoundNotificationsEnabled": true,
"isVoiceCloningSettingsTipDismissed": false
}
}
Champs du résultat
| Champ | Description |
|---|---|
data.companyName | Nom de l’entreprise du compte personnel, ou null. |
data.brandVocabulary | Vocabulaire partagé du propriétaire de l’espace de travail ; un tableau vide indique qu’il n’y en a pas. |
data.customTranslationInstructions | Instructions de traduction partagées du compte ; une chaîne vide signifie qu’il n’y en a aucune. |
data.canEditSharedSettings | Indique si l’appelant peut modifier le vocabulaire partagé et les consignes de traduction. |
data.favoriteTemplates | Favoris de sous-titres et de voix enregistrés, ou null. |
data.favoriteTemplates.dynamicSubtitles | Nom du modèle favori de sous-titres dynamiques, ou null. |
data.favoriteTemplates.voiceIds | Identifiants des voix favorites. |
data.targetLanguagePresets | Préréglages de langue personnels enregistrés. |
data.targetLanguagePresets[].id | Identifiant du préréglage. |
data.targetLanguagePresets[].name | Nom d’affichage du préréglage. |
data.targetLanguagePresets[].languages | Langues enregistrées dans ce préréglage. |
data.socialMediaStatsPresets | Sélections personnelles de chaînes enregistrées. |
data.socialMediaStatsPresets[].channelIds | Identifiants des chaînes enregistrées dans ce préréglage. |
data.textToSpeechBrandPresets | Préréglages personnels d’interprétation de synthèse vocale enregistrés. |
data.textToSpeechBrandPresets[].voice | Identifiant de sélection de voix enregistré. |
data.textToSpeechBrandPresets[].instructionPreset | Nom du préréglage d’interprétation enregistré. |
data.textToSpeechBrandPresets[].instructions | Instructions d’interprétation enregistrées. |
data.textToSpeechBrandPresets[].speed | Multiplicateur de vitesse d’élocution enregistré. |
data.defaultVoiceCloningSettings | Valeurs par défaut de stability et similarity, ou null. |
data.isSoundNotificationsEnabled | Préférence personnelle de notification sonore. |
data.isVoiceCloningSettingsTipDismissed | Indique si l’appelant a fermé le conseil sur les paramètres vocaux. |
Notes de l’opération
- Lorsque le compte est membre d’une équipe, les paramètres partagés proviennent du propriétaire de l’équipe, tandis que les préférences d’interface restent personnelles.
Utilisation
Chaque invocation réussie consomme un appel du quota mensuel API/MCP. Les crédits média et les quotas de génération propres à l’opération s’appliquent également.Erreurs
| Statut HTTP | Code | Signification ou solution |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Des identifiants ont été fournis dans un paramètre de requête access_token ou api_key. Envoyez les identifiants dans les en-têtes. |
| 400 | VALIDATION_ERROR | L’objet JSON contient un champ non pris en charge, une valeur invalide ou un argument obligatoire manquant. |
| 401 | API_KEY_EXPIRED | La clé API a expiré. |
| 401 | INVALID_API_KEY | Fournissez une clé API valide et non expirée. |
| 401 | INVALID_CREDENTIAL | L’en-tête Authorization est mal formé ou entre en conflit avec x-api-key. |
| 401 | MISSING_CREDENTIAL | Aucun identifiant d’authentification utilisable n’a été fourni dans les en-têtes, ou il dépassait 4096 caractères. |
| 401 | USER_NOT_FOUND | Le compte associé à l’identifiant d’accès n’existe plus. |
| 403 | AMBIGUOUS_TEAM_API_KEY | L’utilisateur associé aux identifiants d’authentification appartient à plusieurs équipes, ce qui rend le contexte de facturation ambigu. |
| 403 | INSUFFICIENT_SCOPE | Accordez toutes les autorisations requises ou choisissez d’autres identifiants d’accès. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Les limites d’intégration du compte n’ont pas pu être vérifiées. |
| 403 | SUBSCRIPTION_REQUIRED | Utilisez un abonnement payant actif. |
| 403 | TEAM_MEMBERSHIP_INVALID | L’appartenance actuelle du compte à une équipe ne correspond pas à l’espace de travail de cette connexion. Actualisez l’appartenance et reconnectez-vous. |
| 403 | TEAM_OWNER_NOT_FOUND | Le compte du propriétaire effectif de l’équipe est introuvable. |
| 404 | ACCOUNT_NOT_FOUND | Le compte ou le compte de l’espace de travail actif est introuvable. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Attendez la réinitialisation mensuelle ou changez de forfait. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Respectez Retry-After lorsqu’il est présent et espacez progressivement les nouvelles tentatives. |
| 500 | INTERNAL_ERROR | Vérifiez l’état de la requête enregistrée et l’historique de la ressource avant de décider de réessayer une mutation. |
| 503 | SERVER_RESTARTING | Le serveur redémarre. Réessayez dans un instant en conservant le même identifiant de requête pour une mutation. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["settings:read"]
}
}
Cette page vous a-t-elle été utile ?

