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
}
}
Ajustes y notificaciones
Obtener los ajustes de la cuenta
Obtén el vocabulario guardado, las instrucciones de traducción, los ajustes preestablecidos de voz e idioma, las plantillas favoritas y las preferencias personales de la interfaz.
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
}
}
Obtén el vocabulario guardado, las instrucciones de traducción, los ajustes preestablecidos de voz e idioma, las plantillas favoritas y las preferencias personales de la interfaz.
Permisos necesarios:
POST https://api.voicecheap.ai/v1/actions/settings_get
Autenticación y permisos
string
requerido
Envía una clave de API de VoiceCheap en esta cabecera. También se admite Authorization: Bearer con la misma clave de API. Los tokens de acceso OAuth
solo se aceptan en MCP, no en este endpoint REST.
settings:read.
Se requiere una suscripción de pago activa. Los permisos no cambian los roles del equipo, la propiedad de los recursos, los créditos multimedia ni los límites del plan.
Parámetros
Envía un objeto JSON vacío. Esta acción no tiene campos de entrada.Esquema completo de entrada
Esquema completo de entrada
El JSON Schema siguiente conserva los nombres exactos de los campos, los tipos anidados, los valores predeterminados, los límites y los valores aceptados que expone el descubrimiento. Las reglas adicionales entre campos se indican en las notas de la operación.
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Ejemplos de solicitud
Sustituye los identificadores de recursos y las claves multimedia de los ejemplos por valores devueltos para tu cuenta. Mantén el identificador de solicitud al reintentar la misma modificación.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)
Respuesta
Una primera ejecución correcta devuelve HTTP 200 con el resultado de la operación en data. Una repetición puede devolver el estado de la solicitud guardada en su lugar. El ejemplo muestra una respuesta admitida, no todos los campos opcionales. Devuelve las preferencias personales de quien realiza la llamada y el vocabulario compartido y las instrucciones de traducción del propietario del espacio de trabajo activo.{
"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
}
}
Campos del resultado
| Campo | Descripción |
|---|---|
data.companyName | Nombre de la empresa personal, o null. |
data.brandVocabulary | Vocabulario compartido del propietario del espacio de trabajo; un array vacío indica que no hay ninguno. |
data.customTranslationInstructions | Instrucciones de traducción compartidas de la cuenta; una cadena vacía indica que no hay ninguna. |
data.canEditSharedSettings | Indica si quien realiza la llamada puede cambiar el vocabulario compartido y las instrucciones de traducción. |
data.favoriteTemplates | Favoritos de subtítulos y voces guardados, o null. |
data.favoriteTemplates.dynamicSubtitles | Nombre de la plantilla de subtítulos dinámicos favorita, o null. |
data.favoriteTemplates.voiceIds | Identificadores de voces favoritas. |
data.targetLanguagePresets | Ajustes preestablecidos de idioma personales guardados. |
data.targetLanguagePresets[].id | Identificador del ajuste preestablecido. |
data.targetLanguagePresets[].name | Nombre visible del preajuste. |
data.targetLanguagePresets[].languages | Idiomas guardados en ese ajuste preestablecido. |
data.socialMediaStatsPresets | Selecciones personales de canales guardadas. |
data.socialMediaStatsPresets[].channelIds | Identificadores de canales guardados en ese ajuste preestablecido. |
data.textToSpeechBrandPresets | Ajustes personales preestablecidos de interpretación de texto a voz guardados. |
data.textToSpeechBrandPresets[].voice | Identificador de selección de voz guardado. |
data.textToSpeechBrandPresets[].instructionPreset | Nombre del ajuste preestablecido de interpretación guardado. |
data.textToSpeechBrandPresets[].instructions | Instrucciones de interpretación guardadas. |
data.textToSpeechBrandPresets[].speed | Multiplicador de velocidad de habla guardado. |
data.defaultVoiceCloningSettings | Valores predeterminados de stability y similarity, o null. |
data.isSoundNotificationsEnabled | Preferencia personal de notificaciones sonoras. |
data.isVoiceCloningSettingsTipDismissed | Indica si quien realiza la llamada descartó el consejo de ajustes de voz. |
Notas de la operación
- Cuando la cuenta es miembro de un equipo, los ajustes compartidos proceden del propietario del equipo, mientras que las preferencias de interfaz siguen siendo personales.
Uso
Cada invocación correcta consume una llamada mensual de API/MCP. También se aplican los créditos multimedia y las cuotas de generación propias de la operación.Errores
| Estado HTTP | Código | Significado o solución |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Se han proporcionado credenciales en un parámetro de consulta access_token o api_key. Envía las credenciales en las cabeceras. |
| 400 | VALIDATION_ERROR | El objeto JSON contiene un campo no compatible, un valor no válido o un argumento obligatorio ausente. |
| 401 | API_KEY_EXPIRED | La clave API ha caducado. |
| 401 | INVALID_API_KEY | Proporciona una clave de API válida que no haya caducado. |
| 401 | INVALID_CREDENTIAL | La cabecera Authorization tiene un formato incorrecto o entra en conflicto con x-api-key. |
| 401 | MISSING_CREDENTIAL | No se proporcionó ninguna credencial de cabecera utilizable o superaba 4096 caracteres. |
| 401 | USER_NOT_FOUND | La cuenta de la credencial ya no existe. |
| 403 | AMBIGUOUS_TEAM_API_KEY | El usuario de la credencial pertenece a más de un equipo, por lo que el contexto de facturación es ambiguo. |
| 403 | INSUFFICIENT_SCOPE | Concede todos los permisos necesarios o elige otra credencial. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | No se han podido verificar los límites de integración de la cuenta. |
| 403 | SUBSCRIPTION_REQUIRED | Usa una suscripción de pago activa. |
| 403 | TEAM_MEMBERSHIP_INVALID | La membresía actual de la cuenta en el equipo no coincide con el espacio de trabajo de esta conexión. Actualiza la membresía y vuelve a conectar. |
| 403 | TEAM_OWNER_NOT_FOUND | No se pudo encontrar la cuenta del propietario efectivo del equipo. |
| 404 | ACCOUNT_NOT_FOUND | No se pudo encontrar la cuenta o la cuenta del espacio de trabajo activo. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Espera al restablecimiento mensual o cambia de plan. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Espera el tiempo indicado en Retry-After cuando esté presente y aplica esperas progresivas. |
| 500 | INTERNAL_ERROR | Comprueba el estado de la solicitud guardada y el historial del recurso antes de decidir si reintentas una modificación. |
| 503 | SERVER_RESTARTING | El servidor se está reiniciando. Reinténtalo en breve y conserva el mismo identificador de solicitud para una modificación. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["settings:read"]
}
}
¿Esta página le ayudó?

