Перейти к основному содержимому

Быстрый старт

Описание API​

API сервиса Conspecto предоставляет возможность автоматической загрузки аудио и видеофайлов для транскрибации и создания конспектов. Он разработан для удобного и быстрого преобразования аудиоконтента в текст, с последующей возможностью скачивания результатов в различных форматах.

1. Получение ключа API​

Ключ вы можете получить в личном кабинете в разделе «Ключ API».

Также для получения ключа API можно обратиться к нашему Telegram-боту. Откройте чат с ботом, отправьте команду /get_api_key, бот в ответ пришлет ключ API.

2. Пополнение баланса​

Вы можете пополнить баланс в личном кабинете кнопкой «Пополнить баланс» вверху любой страницы.

Пополнение баланса также осуществляется через Telegram-бота. Воспользуйтесь командой /balance и следуйте инструкциям для пополнения вашего счета.

3. Аутентификация при запросах к эндпоинтам​

Все запросы к API должны содержать заголовок Authorization с вашим ключом API. Формат заголовка:

Authorization: Bearer YOUR_API_KEY

4. Отправка файла на обработку​

Выполняется POST запросом на https://api.conpecto.ru/v1/start с указанием обязательных параметров:

  • language (string, required): Язык аудиофайла в формате ISO 639-1. Например, 'ru', 'en', 'fr'.
  • order_type (string, required): Тип заказа. Поддерживаются только 'transcribe' и 'transcribe+format'.
  • file (binary, required): Аудиофайл для обработки.
  • num_speakers (number, optional): Количество спикеров для разделения. Возможные значения:
    • 0: Без разделения на спикеров (по умолчанию)
    • -1: Автоматическое определение количества спикеров
    • 2-5: Конкретное количество спикеров

В ответ сервер отдает следующие данные:

  • job_id (string): Идентификатор заказа. Вы используете его для проверки статуса заказа и скачивания результата обработки
  • status (string): Текущий статус обработки.
  • amount (number): Стоимость обработки в рублях.
  • remaining_balance (number): Остаток средств на счету пользователя.

Поддерживаемые типы заказов​

На текущий момент поддерживается только 2 типа заказов:

  • transcribe — аудио в текст. Стоимость — 3 ₽ за минуту.
  • transcribe+format — аудио в текст + конспект. Стоимость - 4 ₽ за минуту.

Стоимость​

  • Базовая стоимость:
    • transcribe — аудио в текст. Стоимость — 3 ₽ за минуту.
    • transcribe+format — аудио в текст + конспект. Стоимость - 4 ₽ за минуту.
  • Дополнительная стоимость за разделение на спикеров: +1 ₽ за минуту (если выбрано автоопределение или конкретное число спикеров)

Ограничения​

Максимальный размер загружаемого файла: 2000 Мб.

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

curl -X POST "https://api.conspecto.ru/v1/start" \
     -H "accept: application/json" \
     -H "Content-Type: multipart/form-data" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -F "language=ru" \
     -F "order_type=transcribe" \
     -F "file=@path_to_your_file" \
     -F "num_speakers=2"

Пример ответа сервера:​

{
  "job_id": "dj38aiksk993",
  "status": "pending",
  "amount": 10.0,
  "remaining_balance": 90.0
}

5. Проверка статуса обработки​

Для проверки статуса вашего заказа используйте эндпоинт https://api.conpecto.ru/v1/status/{job_id}.

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

curl -X POST "https://api.conspecto.ru/v1/status/{job_id}" \
     -H "accept: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY"

Возможные статусы заказа:​

  • Pending: Заказ ожидает обработки.
  • Processing: Заказ в процессе обработки.
  • Completed: Заказ завершен и готов к скачиванию.
  • Failed: Произошла ошибка при обработке заказа. Средства возвращены на счет пользователя.

6. Скачивание файла​

Для скачивания обработанного файла используйте эндпоинт https://api.conpecto.ru/v1/download_file/{job_id}/{file_type}/{file_format}.

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

curl -X GET "https://api.conspecto.ru/v1/download_file/{job_id}/{file_type}/{format}" \
     -H "accept: application/octet-stream" \
     -H "Authorization: Bearer YOUR_API_KEY"

Поддерживаемые типы файлов для скачивания (file_type):​

  • Транскрипция: transcribe
  • Конспект: format

Поддерживаемые форматы файлов для скачивания (file_format):​

  • Транскрипция: srt, txt, html, doc, json
  • Конспект: txt, html, doc

7. Получение баланса пользователя​

Для получения текущего баланса пользователя используйте эндпоинт https://api.conpecto.ru/v1/get_balance.

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

curl -X GET "https://api.conspecto.ru/v1/get_balance" \
     -H "accept: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY"

Пример ответа сервера:​

{
  "balance": 90.0
}

8. Получение списка заказов пользователя​

Для получения списка заказов пользователя используйте эндпоинт https://api.conpecto.ru/v1/get_orders.

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

curl -X GET "https://api.conspecto.ru/v1/get_orders" \
     -H "accept: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY"

Пример ответа сервера:​

[
  {
    "order_id": "123",
    "order_created_at": "2023-06-01 10:00:00",
    "job_id": "dj38aiksk993",
    "file_name": "audio.mp3",
    "file_duration": 600,
    "file_language": "ru",
    "order_type": "transcribe",
    "order_status": "Completed",
    "transaction_amount": 30.0,
    "transaction_status": "Successful"
  },
  // ... другие заказы
]

Пример использования API на Python​

Пример использования API на Python в Google Colab.