Upload

Метод Upload

Примените метод Upload для добавления аудиофайла в библиотеку приложения. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/media/v1/Upload

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Параметр Тип Описание
file bytes (Base64) аудиофайл (максимальный размер 5MB)
full_name string имя файла
file_type enum FileType тип аудиофайла
file_metadata_synthesis oneof VoiceSettings голосовые настройки синтеза
description string описание к аудиофайлу
resource_id uint64 идентификатор ресурса аудио

Примечание

Загружаемый аудиофайл не должен превышать размер в 5MB и название файла должно быть в формате MP3 или WAV.

Выходные параметры

Параметр Тип Описание
file_id uint64 идентификатор аудиофайла
resource_id uint64 идентификатор ресурса аудиофайла
size uint64 размер аудиофайла в байтах (не более 15 Мб)
duration uint32 длительность аудиофайла в секундах
name string название файла
description string описание к аудиофайлу
extension string расширение aудиофайла (WAV или MP3)
application_uuid string идентификатор приложения, в библиотеку которого добавлен аудиофайл
file_type enum FileType тип аудиофайла
date_upload string дата загрузки аудиофайла в формате RFC-3339 / ISO-8601

FileType

Параметр Тип Описание
201 enum аудиофайл, загруженный из локального хранилища в библиотеку приложения
202 enum аудиофайл с синтезированной речью

Возможные ошибки

Код Статус Пример сообщения Описание
400 Bad Request “error”: “error Save media service: fileName is exist” аудиофайл с таким именем уже существует
400 Bad Request “error”: “proto: (line 3:18): invalid value for enum type: "254"” невалидное значение в поле file
400 Bad Request “error”: “proto: (line 3:18): invalid value for enum type: "qwe"” невалидное значение в поле file
400 Bad Request “error”: “proto: (line 3:18): invalid value for enum type: ""” не задано значение поля file
400 Bad Request “error”: “proto: syntax error (line 3:18): unexpected token ,” не задано значение поля file
400 Bad Request “error”: “proto: syntax error (line 2:13): unexpected token ,” отсутствует значение поля file
400 Bad Request “error”: “invalid UploadRequest.File: value length must be at least 1 bytes” отсутствует значение поля file
400 Bad Request “error”: “invalid UploadRequest.FullName: value length must be between 1 and 128 runes, inclusive” отсутствует значение поля full_name
400 Bad Request “error”: “proto: (line 5:1): invalid value for string type: }” отсутствует значение поля full_name
401 Unauthorized “error”: “failed to parse token” не указан / неправильно указан API-ключ приложения
404 Not Found неверный URL запроса

Примеры

Входные параметры:

{
   "file": "SUQzAwAAAAAfdlRZRVIAAAAFAAAAMjAyMVRJVDIAAABHAAAB//4TBDgEQgQwBEAEMAQgADwENQQ7BD4ENAQ4BE8EIABABD4EO",
   "file_type": 201,
   "full_name": "exolve_audio.mp3"
}

Выходные параметры:

{
   "file_id": "1931072746905665536",
   "resource_id": "152817",
   "size": "121087",
   "duration": 5,
   "name": "exolve_audio",
   "extension": "mp3",
   "description": "uploaded audio",
   "application_uuid": "178ec145-6848-4b06-a92a-75f63cb57046",
   "file_type": 201,
   "date_upload": "2023-06-14T16:53:40.459734572Z"
}

Содержание статьи