API-документация
API Сквоч позволяет подключить генерацию контента напрямую к сайтам, CMS, маркетплейсам, редакторским системам и внутренним платформам. Вы можете автоматически создавать проекты, запускать задачи, отслеживать статус, забирать результаты и управлять поинтами.
Интерфейс API построен по REST-принципу. Авторизация осуществляется по токену, полученному в личном кабинете. Все вызовы документированы, ответы приходят в формате JSON. API открывает возможности полной автоматизации генерации — без участия человека на каждом этапе.
Вы можете строить любые цепочки: при добавлении товара — сразу запуск генерации описания; при публикации новости — генерация анонса; при обновлении категории — перегенерация SEO-текста. Всё происходит в реальном времени, без ручного переключения между системами.
Для доступа к API Сквоча необходимо использовать уникальный токен, который создаётся вручную в разделе личного кабинета «API-доступ». При генерации токена можно задать его права — например, ограничить только чтением или разрешить запуск генерации и управление поинтами. Это позволяет гибко разграничивать доступ между системами и пользователями.
Каждый запрос к API требует передачи токена в заголовке Authorization: Bearer TOKEN. Без действующего токена вызов методов невозможен. В случае компрометации токена его можно немедленно отозвать и сгенерировать новый. История использования токенов фиксируется и доступна для анализа действий в рамках системы.
Дополнительно поддерживается ограничение по IP-адресам или привязка к проектам. Это даёт возможность повысить безопасность при использовании API в сторонних приложениях. При необходимости можно управлять токенами программно через сам API, обеспечивая масштабируемое управление доступом.
Создание проекта — это базовая операция для последующей генерации. Через API можно задать имя проекта, выбрать язык, указать сценарий, загрузить файл или передать текст напрямую. В ответ вы получите уникальный ID проекта, с которым будете работать далее.
Все задачи привязываются к конкретному проекту, что обеспечивает чистую и логичную структуру данных. Проекты можно фильтровать по дате, статусу, типу задачи, а также получать их список для отображения в интерфейсах CRM, CMS или агентских платформ.
Внутри проекта вы можете запускать десятки или сотни задач, прикладывать новые данные, менять сценарии и контролировать статус. Это удобная модель, когда один проект соответствует товарной категории, лендингу, языку или тематике. Вся история генераций сохраняется и доступна для повторной загрузки.
Для запуска задачи необходимо отправить запрос POST /tasks с телом, содержащим ID проекта, ID сценария и входные данные. Дополнительно можно задать параметры генерации: язык, объём текста, ключевые слова и ограничения по символам. Запросы обрабатываются моментально.
После старта генерации вы получаете ID задачи и можете отслеживать статус: в очереди, выполняется, завершено или ошибка. Обновление статуса возможно через Webhook или по отдельному запросу. Вся информация возвращается в JSON и пригодна для отображения в любом интерфейсе.
API Сквоч поддерживает массовые генерации: можно отправить файл с тысячами строк и запустить автоматическую обработку по каждой позиции. Это удобно для каталогов, новостных сайтов и SEO-проектов, где требуется большое количество уникальных текстов.
Результаты генерации доступны по ID задачи. Метод GET /tasks/{id}/result возвращает не только текст, но и всю техническую информацию: дата генерации, ID сценария, расход поинтов, формат вывода и HTML-структура, если она была задана в сценарии.
Для массовых задач результат доступен в виде архива или отдельными строками. Также можно выбрать формат ответа: JSON, CSV, TXT или HTML. Это позволяет гибко адаптировать процесс под требования внутренней платформы или стороннего редактора.
Полученные данные можно моментально отправить в CMS, CRM или редактор контента. Это исключает ручную загрузку, позволяет автоматизировать публикации и минимизирует задержки между генерацией и использованием текста. Также доступна выгрузка результатов в файл.
В API предусмотрены методы для отслеживания текущего баланса, истории списаний и предварительной оценки стоимости генерации. Это важно для планирования бюджета и автоматического контроля затрат на контент. Все операции привязаны к проекту и сценарию.
Каждая задача содержит информацию о том, сколько поинтов было потрачено, какой длины получился текст, когда была выполнена генерация. Это позволяет строить аналитику, учитывать эффективность сценариев и корректировать параметры на лету.
Перед запуском задачи можно запросить предварительный расчёт по символам и поинтам. Такой механизм особенно удобен при интеграции Сквоча в динамичные процессы — например, когда сценарии и объёмы текста задаются программно и заранее нужно понимать стоимость.
