Перейти к содержанию

Ссылка API

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

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

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

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

https://api.threada.ai

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

  • Используйте учетные данные с ограниченной областью действия для доступа к API
  • Включите контекст клиента и роли, где это необходимо.
  • Запросы без действительного контекста закрываются с ошибкой

Типичные области применения

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

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

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

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

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

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

Создайте WorkItem из полезных данных приема.

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

Запрос
curl -X POST "https://api.threada.ai/work-items" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{\"workflow_id\":\"policy_review\",\"channel_id\":\"web_main\",\"payload\":{\"message\":\"Review this renewal request before approval\"}}"
Ответ
{
  "work_item_id": "wi_123",
  "status": "new",
  "workflow_id": "policy_review"
}

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

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

Запрос
curl -X POST "https://api.threada.ai/actions/execute" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{\"work_item_id\":\"wi_123\",\"action_id\":\"request_approval\",\"integration_id\":\"int_workflow\"}"
Ответ
{
  "execution_id": "ex_456",
  "status": "started",
  "idempotency_key": "idem_789"
}

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

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

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