Справочник API

Справочник по операциям WorkItem, контролям шага принятия решений, выполнению интеграций и экспорту телеметрии.

Эти API спроектированы для предсказуемого поведения автоматизации с явным заданием политик и области tenant.

Базовая конечная точка

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

https://api.threada.ai

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

Используйте учётные данные с ограниченной областью для доступа к API
Включайте контекст tenant и роли там, где это требуется
Запросы без действительного контекста отклоняются по принципу fail-closed

Типичные области (scopes)

workitems:read и workitems:write
workflow:manage для обновлений политик и решений
actions:execute для управляемого выполнения
telemetry:read для экспорта и анализа

Пагинация и фильтрация

Конечные точки списков поддерживают пагинацию на основе курсора или токена
Фильтрация по каналу, рабочему процессу, статусу, версии политики и временному диапазону
Для больших экспортов телеметрии предпочтительны ограниченные окна

Модель ошибок

Типизированные категории ошибок для сбоев проверки, авторизации, политик и выполнения
Коды причин поддерживают детерминированную обработку в инструментах оператора
Идентификаторы корреляции возвращаются для межсервисного разбора

Примеры запросов

Создание WorkItem из полезной нагрузки приёма

Создайте каноническую рабочую запись для обработки рабочего процесса. При необходимости укажите идентификатор канала приёма.

Запрос

curl -X POST "https://api.threada.ai/api/v1/public/work-items" \
  -H "X-API-Key: <api-key>" \
  -H "Content-Type: application/json" \
  -d "{\"subject\":\"Review renewal request\",\"channel\":\"web\",\"channel_id\":\"web_main\",\"initial_message\":{\"role\":\"user\",\"content\":\"Review this renewal request before approval\"},\"tags\":[\"policy_review\"]}"

Ответ

{
  "work_item": {
    "summary": {
      "work_item_id": "wi_123",
      "status": "new",
      "subject": "Review renewal request"
    }
  }
}

Выполнение одобренного действия

Запустите одобренное политикой действие для настроенной интеграции.

Запрос

curl -X POST "https://api.threada.ai/api/v1/public/work-items/wi_123/actions" \
  -H "X-API-Key: <api-key>" \
  -H "Content-Type: application/json" \
  -d "{\"integration_id\":\"int_workflow\",\"idempotency_key\":\"act_456\",\"payload\":{\"type\":\"custom_http\",\"method\":\"POST\",\"url\":\"https://api.example.com/approvals\",\"body_json\":\"{\\\"approved\\\":true}\"}}"

Ответ

{
  "action": {
    "action_id": "act_456",
    "work_item_id": "wi_123",
    "action_type": "custom_http",
    "status": "completed"
  }
}

Примеры артефактов

Иллюстративные примеры объектов, которые создаёт Threada, с синтетическими данными — без реальных клиентов или записей. Имена полей соответствуют схемам API и аудита Threada.

Нужны рекомендации по внедрению?

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

Связаться с технической командой