RU
Выберите тему:

API Документация

Интегрируйте Softyu Office в свои приложения. Программный доступ к задачам, агентам, файлам и данным рабочей области.

База URL
https://office.softyu.org/api/v1
Версия
v1

Аутентификация

Для всех запросов API требуется действительный ключ API. Включите свой ключ в Authorization заголовок как токен носителя.

// HTTP-заголовок
Authorization: Bearer so_live_your_api_key_here
Как получить ключ API: Перейти к Настройки → API Ключи на панели управления и нажмите «Сгенерировать ключ API». Храните его в надежном месте — после создания вы больше не сможете его увидеть.
// Пример cURL-запроса
curl -X GET https://office.softyu.org/api/v1/tasks \
  -H "Authorization: Bearer so_live_7cf8a9b2e1d4..." \
  -H "Content-Type: application/json"

Задачи

Создавайте, перечисляйте и управляйте задачами агента AI в своем рабочем пространстве.

Возвращает постраничный список задач в рабочей области, упорядоченный по дате создания (сначала самые новые).

ПараметрТипОписание
limitintegerМаксимальное количество возвращаемых результатов (по умолчанию: 50, максимум: 200)
statusstringФильтровать по статусу: ожидание, работа, завершено, ошибка
offsetintegerСмещение нумерации страниц (по умолчанию: 0)
// Ответ 200
{
  "tasks": [
    {
      "id": 42,
      "title": "Write blog post about AI trends",
      "status": "completed",
      "priority": 5,
      "agent": "Content Writer",
      "created_at": "2026-06-10T14:30:00Z"
    }
  ],
  "total": 156
}

Создайте новую задачу и назначьте ее агенту AI.

ПолеТипОбязательноОписание
titlestringДаНазвание задачи (максимум 500 символов)
descriptionstringДаПодробное описание задачи
agent_idintegerНетИдентификатор назначаемого агента
priorityintegerНетУровень приоритета 1-10 (по умолчанию: 5)
// Тело запроса
{
  "title": "Analyze Q2 sales data",
  "description": "Process the Q2 CSV and generate summary",
  "agent_id": 3,
  "priority": 8
}

Возвращает полную информацию о конкретной задаче, включая результат, сообщение об ошибке и связанные файлы.

Агенты

Составляйте список агентов AI и управляйте ими в своем рабочем пространстве.

Возвращает всех агентов AI, находящихся в настоящее время в вашей рабочей группе.

// Ответ 200
{
  "agents": [
    {
      "id": 3,
      "name": "Content Writer",
      "role": "content",
      "status": "active"
    }
  ]
}

Чат

Создавайте сообщения чата в рабочей области и получайте историю разговоров.

ПолеТипОбязательноОписание
messagestringДаСодержание сообщения
agent_idintegerНетЦелевой агент для прямых сообщений
ПараметрТипОписание
limitintegerМаксимальное количество сообщений (по умолчанию: 50)
agent_idintegerФильтровать по конкретному агенту DM

Файлы

Доступ к файлам, созданным агентами AI.

Возвращает все сгенерированные файлы в вашей рабочей области с токенами загрузки.

Загрузите файл, используя его уникальный токен загрузки. Возвращает двоичный файл с соответствующим типом MIME.

Рабочая область

Получите информацию и статистику о рабочей области.

// Ответ 200
{
  "name": "My Workspace",
  "company": "Softyu LLC",
  "plan": "pro",
  "agents_count": 5,
  "tasks_count": 156,
  "storage_used_mb": 245.8
}

Отслеживание использования

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

API Ключ Ключ
Использование
засчитывается за запрос
Задачи
План
применяется ежедневный лимит задач
Файлы
Токен
требуется ключ рабочей области
Отозванные API-ключи немедленно возвращают 401. Создать или отозвать ключи можно здесь: Настройки → API-ключи.

Коды ошибок

Используются стандартные коды ошибок HTTP. Ответы об ошибках включают тело JSON с подробной информацией.

КодСтатусОписание
400Неверный запрос ЗначокНеверное тело запроса или отсутствуют обязательные поля.
401НесанкционированныйОтсутствует или недействителен ключ API.
403ЗапрещеноAPI не имеет доступа к этому ресурсу.
404не найденРесурс не найден
500Ошибка сервераВнутренняя ошибка сервера — обратитесь в службу поддержки.
// Формат ответа с ошибкой
{
  "error": "Unauthorized",
  "message": "Invalid or expired API key",
  "code": 401
}