Расшифровки

Примечания
Для опытных пользователей
Передавайте API-ключ как Bearer-токен в заголовке Authorization. Создать API-ключ.
Список

URL API:

GET 
https://nexchat.store/api/v1/transcriptions

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

curl --location --request GET 'https://nexchat.store/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. По умолчанию: 10.
Открыть

URL API:

GET 
https://nexchat.store/api/v1/transcriptions/{id}

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

curl --location --request GET 'https://nexchat.store/api/v1/transcriptions/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Создать

URL API:

POST 
https://nexchat.store/api/v1/transcriptions

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

curl --location --request POST 'https://nexchat.store/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.
Сохранить

URL API:

PUT PATCH 
https://nexchat.store/api/v1/transcriptions/{id}

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

curl --location --request PUT 'https://nexchat.store/api/v1/transcriptions/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
name
дополнительно string
Например: Интервью с клиентом
result
дополнительно string
Например: расшифровка аудио с выделенными тезисами
favorite
дополнительно boolean
Находится ли расшифровка в избранном.
Удалить

URL API:

DELETE 
https://nexchat.store/api/v1/transcriptions/{id}

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

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