AtomiksAPI
Ver .md

flows.catalog

Catálogo de eventos e nós dos flows. Eventos que iniciam ou encerram um flow (com filtros e canais aceitos) e os tipos de nó, cada um com um exemplo de configuração e os handles de saída. As arestas do grafo usam sourceHandle igual a um desses handles; send_message só tem btn:<id>, reply e no_reply quando tem waitReply.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/flows.catalog (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: automations:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: flows_catalog
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId flows.catalog)

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/flows.catalog \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs flows.catalog --json '{}'

MCP: ferramenta flows_catalog com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "group": {
            "type": "string"
          },
          "filters": {
            "type": "array",
            "items": {}
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "name",
          "label",
          "group",
          "filters"
        ],
        "additionalProperties": false
      }
    },
    "nodeTypes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "handles": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "sample": {}
        },
        "required": [
          "type",
          "handles",
          "sample"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "events",
    "nodeTypes"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).