Начало работы
Всё необходимое для выполнения первого API-запроса
Базовые URL-адреса
Moknah предоставляет два типа эндпоинтов в зависимости от вашего сценария использования:
Стандартный REST API (для разовых запросов):
https://moknah.io/api/v1/
WebSocket API реального времени (для непрерывной потоковой передачи):
wss://moknah.io/api/v1/
Аутентификация
API Moknah использует API-ключи для аутентификации. Включите свой API-ключ в Authorization заголовок с использованием
Предъявитель схема при каждом HTTP-запросе и рукопожатии WebSocket.
Authorization: Bearer YOUR_API_KEY
Получение API-ключа
- Войдите в свою Панель управления Moknah
- Оформите подписку на тариф Pro или свяжитесь с нами Продажи для корпоративного доступа.
- Перейти к API
- Нажмите Управление ключами API
- Нажмите Новый ключ
- Скопируйте и надежно сохраните свой ключ.
Никогда не раскрывайте свой API-ключ в клиентском коде или публичных репозиториях. Относитесь к нему как к паролю.
Краткий пример использования HTTP
Вот полный пример генерации речи из текста с использованием стандартного REST API:
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("Аудио сохранено!")
else:
print(f"Ошибка: {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();
// Используйте аудио-блоб
console.log("Аудио сгенерировано!");
} else {
const error = await response.json();
console.error(error);
}
Формат ответа
Ответы об успешном выполнении
Успешные ответы различаются в зависимости от конечной точки:
- Генерация TTS (POST): Возвращает полные бинарные аудиоданные в запрошенном формате output_format (по умолчанию — audio/mpeg).
- Поток TTS (WSS): Непрерывно передает потоком бинарные фрагменты MP3 по мере их формирования.
- Другие конечные точки: Возвращает структурированные данные в формате JSON
Заголовки ограничения частоты запросов (только HTTP)
Каждый HTTP-ответ содержит информацию об ограничениях частоты запросов (в случае с WebSockets ограничения обеспечиваются путем закрытия соединений):
| Заголовок | Описание |
|---|---|
| RateLimit-Limit | Максимальное количество запросов в минуту |
| RateLimit-Remaining | Запросы, оставшиеся в текущем окне |
| RateLimit-Reset | Unix-метка времени сброса лимита |
| Moknah-Credits-Remaining | Ваш оставшийся кредитный баланс |
Распространенные коды ошибок
| Код | Тип | Описание |
|---|---|---|
| 400 | INVALID_REQUEST |
Неверные параметры или некорректный JSON |
| 401 | UNAUTHORIZED |
Неверный или отсутствующий API-ключ |
| 402 | INSUFFICIENT_CREDITS |
На счете недостаточно кредитов |
| 429 | RATE_LIMIT_EXCEEDED |
Слишком много запросов (HTTP) |
| 4290 | CONCURRENT_LIMIT |
Слишком много активных соединений (WSS) |
| 500 | INTERNAL_SERVER_ERROR |
Ошибка сервера |
Посмотрите на Ошибки страница с подробными рекомендациями по обработке ошибок.
Дальнейшие шаги
Теперь, когда всё настроено, ознакомьтесь с доступными эндпоинтами:
Получить доступные голоса для TTS
Преобразовать текст в аудио
TTS через WebSocket в реальном времени
Извлечь текст из аудиофайла
Распознавание речи (STT) через WebSocket в реальном времени
По вопросам или проблемам, связанным с API, обращайтесь к нам по адресу api@moknah.io.