Ver .md

flows.import

Importar flow. Cria um rascunho a partir do JSON de flows.export. name substitui o nome do arquivo.

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

Entrada

CampoTipoObrigatórioNota
dataobjectsim
namestringnão
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "schema": {
          "type": "number",
          "const": 1
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        "graph": {
          "description": "Grafo do flow: {schema: 1, nodes, edges}. Veja flows.catalog para os tipos de nó e handles."
        }
      },
      "required": [
        "schema",
        "name",
        "graph"
      ]
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    }
  },
  "required": [
    "data"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/flows.import \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data":{"schema":1,"name":"Boas-vindas","graph":{"schema":1,"nodes":[{"id":"trigger","type":"trigger","position":{"x":0,"y":0},"config":{"start":[],"exit":[]}}],"edges":[]}}}'

CLI:

node cli/atomiks.mjs flows.import --json '{"data":{"schema":1,"name":"Boas-vindas","graph":{"schema":1,"nodes":[{"id":"trigger","type":"trigger","position":{"x":0,"y":0},"config":{"start":[],"exit":[]}}],"edges":[]}}}'

MCP: ferramenta flows_import com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "active",
        "paused",
        "archived"
      ]
    },
    "publishedVersion": {
      "type": [
        "number",
        "null"
      ]
    },
    "folder": {
      "type": [
        "string",
        "null"
      ]
    },
    "latestVersion": {
      "type": [
        "number",
        "null"
      ]
    },
    "hasDraft": {
      "type": "boolean"
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "status",
    "publishedVersion",
    "folder",
    "latestVersion",
    "hasDraft",
    "createdAt",
    "updatedAt"
  ],
  "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).