Saltar para o conteúdo

Referência da API

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

Estas APIs foram projetadas para um comportamento de automação previsível, com política explícita e delimitação por locatário.

Endpoint base

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

https://api.threada.ai

Autenticação e contexto

  • Use credenciais delimitadas para acesso à API
  • Inclua o contexto de locatário e de função quando necessário
  • Solicitações sem contexto válido falham de forma fechada

Escopos típicos

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

Paginação e filtragem

  • Os endpoints de listagem 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 erro tipadas para falhas de validação, autorização, política e execução
  • Os códigos de motivo 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

Criar um WorkItem a partir de uma carga 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.

Solicitação 
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\"]}"
Resposta 
{
  "work_item": {
    "summary": {
      "work_item_id": "wi_123",
      "status": "new",
      "subject": "Review renewal request"
    }
  }
}

Executar uma ação aprovada

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

Solicitação 
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}\"}}"
Resposta 
{
  "action": {
    "action_id": "act_456",
    "work_item_id": "wi_123",
    "action_type": "custom_http",
    "status": "completed"
  }
}

Artefatos de exemplo

Exemplos ilustrativos dos objetos que a Threada produz, com dados sintéticos — não são clientes nem registros reais. Os nomes dos campos seguem os schemas de API e de auditoria da Threada.

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