Primeros pasos
Todo lo que necesitas para hacer tu primera solicitud a la API
URL base
Moknah ofrece dos tipos de endpoints según tu caso de uso:
API REST estándar (para solicitudes individuales):
https://moknah.io/api/v1/
API WebSocket en tiempo real (para transmisión continua):
wss://moknah.io/api/v1/
Autenticación
La API de Moknah utiliza claves API para la autenticación. Incluye tu clave API en el encabezado Authorization usando el esquema
Bearer con cada solicitud HTTP y handshake de WebSocket.
Authorization: Bearer YOUR_API_KEY
Cómo obtener tu clave API
- Inicia sesión en tu Panel de Moknah
- Suscríbete al plan Pro o contacta con Ventas para acceso empresarial.
- Ve a API
- Haz clic en Gestionar claves API
- Haz clic en Nueva clave
- Copia y guarda tu clave en un lugar seguro
Nunca expongas tu clave API en el código del lado del cliente ni en repositorios públicos. Trátala como una contraseña.
Ejemplo rápido de HTTP
Aquí tienes un ejemplo completo para generar voz a partir de texto usando la API REST estándar:
curl -X POST "https://moknah.io/api/v1/tts/generate/" \
-H "Authorization: Bearer your_api_key" \
-H "Content-Type: application/json" \
-d '{
"text": "مرحبا بك في منصة مكنة",
"voice_id": 1
}' \
--output speech.mp3
import requests
response = requests.post(
"https://moknah.io/api/v1/tts/generate/",
headers={
"Authorization": f"Bearer your_api_key",
},
json={
"text": "مرحبا بك في منصة مكنة",
"voice_id": 1
}
)
if response.status_code == 200:
with open("speech.mp3", "wb") as f:
f.write(response.content)
print("¡Audio guardado!")
else:
print(f"Error: {response.json()}")
const response = await fetch(
'https://moknah.io/api/v1/tts/generate/',
{
method: 'POST',
headers: {
'Authorization': 'Bearer your_api_key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
text: 'مرحبا بك في منصة مكنة',
voice_id: 1
})
}
);
if (response.ok) {
const blob = await response.blob();
// Usar el blob de audio
console.log("¡Audio generado!");
} else {
const error = await response.json();
console.error(error);
}
Formato de respuesta
Respuestas exitosas
Las respuestas exitosas varían según el endpoint:
- Generación TTS (POST): Devuelve los datos de audio binarios completos en el output_format solicitado (audio/mpeg por defecto)
- Transmisión TTS (WSS): Transmite fragmentos MP3 binarios de forma continua a medida que se generan
- Otros endpoints: Devuelve datos JSON estructurados
Encabezados de límite de tasa (solo HTTP)
Cada respuesta HTTP incluye información sobre los límites de tasa (los WebSockets aplican límites cerrando la conexión):
| Encabezado | Descripción |
|---|---|
| RateLimit-Limit | Máximo de solicitudes por minuto |
| RateLimit-Remaining | Solicitudes restantes en la ventana actual |
| RateLimit-Reset | Marca de tiempo Unix cuando se restablece el límite |
| Moknah-Credits-Remaining | Tu saldo de créditos restante |
Códigos de error comunes
| Código | Tipo | Descripción |
|---|---|---|
| 400 | INVALID_REQUEST |
Parámetros no válidos o JSON mal formado |
| 401 | UNAUTHORIZED |
Clave API no válida o faltante |
| 402 | INSUFFICIENT_CREDITS |
La cuenta no tiene suficientes créditos |
| 429 | RATE_LIMIT_EXCEEDED |
Demasiadas solicitudes (HTTP) |
| 4290 | CONCURRENT_LIMIT |
Demasiadas conexiones activas (WSS) |
| 500 | INTERNAL_SERVER_ERROR |
Error del servidor |
Consulta la página Errores para obtener una guía detallada sobre el manejo de errores.
Próximos pasos
Ahora que todo está listo, explora los endpoints disponibles:
Obtener voces disponibles para TTS
Convertir texto a audio
TTS en tiempo real por WebSocket
Extraer texto de un archivo de audio
STT en tiempo real por WebSocket
Para preguntas o problemas relacionados con la API, contáctanos en api@moknah.io.