Голос в текст - Разработчикам

Примечания

Экспертный уровень

Ключ API должен быть отправлен в качестве токена Bearer в заголовке Authorization запроса. Get your API key.

Список

API endpoint:

GET

https://ailuna.ru/api/v1/transcriptions

Пример запроса:

curl --location --request GET 'https://ailuna.ru/api/v1/transcriptions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Параметр

Тип

Описание

search

дополнительно string

Поисковый запрос.

search_by

дополнительно string

Поиск по. Возможные значения: name для Имя, result для Результат. По умолчанию: name.

favorite

дополнительно boolean

Фильтр по избранному.

sort_by

дополнительно string

Сортировать по. Возможные значения: id для Дата создания, name для Имя. По умолчанию: id.

sort

дополнительно string

Сортировать. Возможные значения: desc для Нисходящий, asc для Восходящий. По умолчанию: desc.

per_page

дополнительно integer

Результаты на страницу. Возможные значения: 10, 25, 50, 100. По умолчанию: 25.

Показать

API endpoint:

GET

https://ailuna.ru/api/v1/transcriptions/{id}

Пример запроса:

curl --location --request GET 'https://ailuna.ru/api/v1/transcriptions/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Store

API endpoint:

POST

https://ailuna.ru/api/v1/transcriptions

Пример запроса:

curl --location --request POST 'https://ailuna.ru/api/v1/transcriptions' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--form 'name={name}' \
--form 'file=@{file}'

Параметр

Тип

Описание

name

требуется string

Название транскрипции.

file

требуется file

Аудиофайл.

description

дополнительно string

Описание аудиофайла.

language

дополнительно string

Язык аудиофайла. Значение должно быть в формате ISO 3166-1 alpha-2 стандарт.

Обновление

API endpoint:

PUT PATCH

https://ailuna.ru/api/v1/transcriptions/{id}

Пример запроса:

curl --location --request PUT 'https://ailuna.ru/api/v1/transcriptions/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Параметр

Тип

Описание

name

дополнительно string

Название транскрипции.

result

дополнительно string

Результат транскрипции.

favorite

дополнительно boolean

Является ли транскрипция избранной или нет.

Удалить

API endpoint:

DELETE

https://ailuna.ru/api/v1/transcriptions/{id}

Пример запроса:

curl --location --request DELETE 'https://ailuna.ru/api/v1/transcriptions/{id}' \
--header 'Authorization: Bearer {api_key}'