Saltar para o conteúdo

Referência API

Referência para operações de WorkItem, controles de etapas de decisão, execução de integração e exportação de telemetria.

Esses APIs foram projetados para um comportamento de automação previsível com política explícita e escopo de locatário.

Ponto de extremidade básico

Use seu endpoint API público configurado para solicitações autenticadas.

https://api.threada.ai

Autenticação e contexto

  • Use credenciais com escopo definido para acesso à API
  • Incluir o contexto do locatário e da função quando necessário
  • Solicitações sem contexto válido falham no fechamento

Escopos típicos

  • workitems:read e workitems:write
  • workflow:manage para atualizações de políticas e decisões
  • actions:execute para execução governada
  • telemetry:read para exportações e análises

Paginação e filtragem

  • Os pontos de extremidade da lista suportam paginação baseada em cursor ou token
  • Filtre por canal, fluxo de trabalho, status, versão da política e intervalo de tempo
  • Prefira janelas limitadas para grandes exportações de telemetria

Modelo de erro

  • Categorias de erros digitados para falhas de validação, autorização, política e execução
  • Os códigos de razão suportam o tratamento determinístico nas ferramentas do operador
  • IDs de correlação são retornados para investigação entre serviços

Solicitações de exemplo

Crie um WorkItem a partir da carga útil de entrada

Crie um registro de trabalho canônico para processamento de fluxo de trabalho. Inclua o identificador do canal de entrada quando necessário.

Solicitar 
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\"}}"
Resposta 
{
  "work_item_id": "wi_123",
  "status": "new",
  "workflow_id": "policy_review"
}

Execute uma ação aprovada

Execute uma ação aprovada por política em uma integração configurada.

Solicitar 
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\"}"
Resposta 
{
  "execution_id": "ex_456",
  "status": "started",
  "idempotency_key": "idem_789"
}

Precisa de orientação de implementação?

Use a documentação e a visão geral técnica para padrões de implantação e governança.

Contate a equipe técnica