curl --request POST 'https://api.voicecheap.ai/v1/actions/account_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/account_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/account_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": {
"userId": "user_123",
"email": "developer@example.com",
"displayName": "Studio owner",
"companyName": "Studio",
"plan": "pro",
"workspace": {
"ownerUserId": "user_123",
"teamId": null,
"isTeamMember": false
},
"credits": {
"availableMinutes": 150,
"includedMinutes": 120,
"purchasedMinutes": 30,
"textToSpeech": {
"limit": 4000000,
"used": 125000,
"remaining": 3925000,
"includedRemaining": 3875000,
"purchasedRemaining": 50000,
"resetsAt": 1793491200000
}
},
"permissions": {
"scopes": [
"account:read"
],
"canManageOwnTeam": false,
"canEditSharedSettings": true
},
"limits": {
"maxConcurrentTranslations": 5,
"accessToLipSyncPro": false
}
}
}
Cuenta
Obtener la cuenta y los saldos de créditos
Obtén la identidad de tu cuenta, el plan efectivo, los saldos de minutos incluidos y comprados, el saldo de caracteres de texto a voz y los permisos de esta conexión.
POST
/
v1
/
actions
/
account_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/account_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/account_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/account_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": {
"userId": "user_123",
"email": "developer@example.com",
"displayName": "Studio owner",
"companyName": "Studio",
"plan": "pro",
"workspace": {
"ownerUserId": "user_123",
"teamId": null,
"isTeamMember": false
},
"credits": {
"availableMinutes": 150,
"includedMinutes": 120,
"purchasedMinutes": 30,
"textToSpeech": {
"limit": 4000000,
"used": 125000,
"remaining": 3925000,
"includedRemaining": 3875000,
"purchasedRemaining": 50000,
"resetsAt": 1793491200000
}
},
"permissions": {
"scopes": [
"account:read"
],
"canManageOwnTeam": false,
"canEditSharedSettings": true
},
"limits": {
"maxConcurrentTranslations": 5,
"accessToLipSyncPro": false
}
}
}
Obtén la identidad de tu cuenta, el plan efectivo, los saldos de minutos incluidos y comprados, el saldo de caracteres de texto a voz y los permisos de esta conexión.
Permisos necesarios:
POST https://api.voicecheap.ai/v1/actions/account_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.
account: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/account_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/account_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/account_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 el perfil público del autor de la llamada, el plan efectivo, el espacio de trabajo activo, los créditos multimedia disponibles, los permisos de conexión y los límites de traducción.{
"data": {
"userId": "user_123",
"email": "developer@example.com",
"displayName": "Studio owner",
"companyName": "Studio",
"plan": "pro",
"workspace": {
"ownerUserId": "user_123",
"teamId": null,
"isTeamMember": false
},
"credits": {
"availableMinutes": 150,
"includedMinutes": 120,
"purchasedMinutes": 30,
"textToSpeech": {
"limit": 4000000,
"used": 125000,
"remaining": 3925000,
"includedRemaining": 3875000,
"purchasedRemaining": 50000,
"resetsAt": 1793491200000
}
},
"permissions": {
"scopes": [
"account:read"
],
"canManageOwnTeam": false,
"canEditSharedSettings": true
},
"limits": {
"maxConcurrentTranslations": 5,
"accessToLipSyncPro": false
}
}
}
Campos del resultado
| Campo | Descripción |
|---|---|
data.userId | Identificador de la cuenta autenticada. |
data.email | Dirección de correo electrónico de la cuenta autenticada. |
data.displayName | Nombre para mostrar de la cuenta autenticada. |
data.companyName | Nombre de la empresa guardado, o null. |
data.plan | Plan efectivo usado por esta conexión. |
data.workspace.ownerUserId | Cuenta propietaria de los proyectos y los créditos de minutos del espacio de trabajo activo. |
data.workspace.teamId | Identificador del equipo activo, o null para un espacio de trabajo personal. |
data.workspace.isTeamMember | Indica si esta conexión actúa como miembro en el espacio de trabajo del propietario de un equipo. |
data.credits.availableMinutes | Total de minutos enteros disponibles, incluidos los créditos comprados. |
data.credits.includedMinutes | Minutos completos disponibles del saldo incluido. |
data.credits.purchasedMinutes | Minutos enteros disponibles de los créditos de minutos comprados. |
data.credits.textToSpeech.limit | Cuota de caracteres de texto a voz incluidos para el período de cuota actual. |
data.credits.textToSpeech.used | Caracteres de texto a voz incluidos usados durante el período actual. |
data.credits.textToSpeech.remaining | Caracteres de texto a voz disponibles, incluidos y comprados. |
data.credits.textToSpeech.includedRemaining | Caracteres de texto a voz incluidos disponibles. |
data.credits.textToSpeech.purchasedRemaining | Caracteres de texto a voz comprados disponibles. |
data.credits.textToSpeech.resetsAt | Final del período actual de cuota de texto a voz en milisegundos, o null cuando no hay ningún período activo. |
data.permissions.scopes | Permisos concedidos a esta clave de API o conexión MCP. |
data.permissions.canManageOwnTeam | Indica si la cuenta autenticada ya es propietaria de un equipo. |
data.permissions.canEditSharedSettings | Indica si quien realiza la llamada puede editar el vocabulario del espacio de trabajo y las instrucciones de traducción de la cuenta. |
data.limits.maxConcurrentTranslations | Cuota efectiva de traducciones simultáneas. |
data.limits.accessToLipSyncPro | Indica si la cuenta efectiva de esta conexión tiene acceso a la sincronización labial Pro. |
Notas de la operación
- Los créditos de minutos pertenecen al espacio de trabajo personal o de equipo activo. El historial de texto a voz y los créditos de caracteres pertenecen a la cuenta autenticada.
- Los periodos de cuota de texto a voz duran 30 días desde la primera generación posterior al final del periodo anterior; su restablecimiento es independiente de las llamadas de integración del mes natural.
- Esta acción no devuelve claves de API guardadas, secretos de firma de webhooks ni credenciales de cuentas externas.
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": ["account:read"]
}
}
¿Esta página le ayudó?

