Руководство по миграции
Перейдите от устаревших путей Open API к Open API v1.
Руководство по миграции
Новые интеграции должны вызывать /api/open/v1. Устаревшие пути остаются доступными в течение окна совместимости, но их не следует использовать для новой работы.
Сопоставление путей
| Путь наследия | Открыть путь API v1 |
|---|---|
POST /api/open/create-model | POST /api/open/v1/voices |
POST /api/open/delete-model | DELETE /api/open/v1/voices/{voiceId} |
POST /api/open/list-models | GET /api/open/v1/voices |
POST /api/open/lip-sync/create | POST /api/open/v1/media/lip-sync/jobs |
GET /api/open/lip-sync/list | GET /api/open/v1/media/lip-sync/jobs |
GET /api/open/lip-sync/query | GET /api/open/v1/media/lip-sync/jobs/{jobId} |
Подтвердите окончательные формы запроса и ответа с помощью:
GET /api/openapi.jsonРекомендуемый порядок
- Сначала переключите вызовы, доступные только для чтения, такие как профиль, список голосов и статус задания.
- Переместите конечные точки создания после того, как анализ запросов и ответов будет охвачен тестами.
- Продолжайте регистрировать как устаревшую конечную точку, так и новую конечную точку во время развертывания.
- Удаляйте устаревшие клиентские пути только после того, как рабочий трафик больше не зависит от них.
Запросить изменения
Используйте аутентификацию носителя для каждого запроса v1.
Authorization: Bearer KITTA_API_KEYИспользуйте стабильные идентификаторы в телах запросов. Для TTS передавайте идентификатор голоса в voiceId, а идентификатор модели TTS — в modelId. Только reference_id остается устаревшим псевдонимом идентификатора голоса.
Используйте общедоступный системный голос 00a1b221-6137-4b73-ad62-b0cbce134167 для небольшого дымового теста миграции, затем переключитесь на рабочий голосовой идентификатор, выбранный вашим приложением.
Изменения ответа
Конечные точки версии 1 созданы на основе явных ресурсов: голосов, задач, заданий и записей профилей. Обновите свой клиент, чтобы он анализировал поля ответа, специфичные для конечной точки, вместо того, чтобы зависеть от одной глобальной формы оболочки.
Для асинхронных операций с мультимедиа немедленно сохраните возвращенное задание или идентификатор задачи. Этот идентификатор должен использоваться при опросах, повторных попытках и расследованиях поддержки.
Выставление счетов и кредиты
Сама по себе миграция не меняет баланс учетной записи, но новые конечные точки могут предоставлять более четкие поля кредитов и квот. Во время развертывания сравнивайте старые и новые пути кода на небольших заданиях, прежде чем перемещать большой объем трафика.
Если запрос не выполнен во время миграции, зарегистрируйте устаревший путь, новый путь, код состояния, API requestId и внутренний идентификатор задания. Это обеспечивает поддержку достаточного контекста, не раскрывая ключи носителя API или URL-адреса частных носителей.