Ver .md

custom_objects.records_import_ai_column

Sugerir o campo de uma coluna da planilha com IA. Equivale a records/import/ai-suggest-column do original ("Sugerir campo com IA" no mapeamento). Manda o nome da coluna e até 10 valores ao modelo e devolve até 3 candidates ({customFieldId, confidence: high|medium|low, reason}). Sem a chave da IA ou com falha, responde o erro credencial_ausente ou internal (a tela mostra "Não foi possível analisar agora").

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

Entrada

CampoTipoObrigatórioNota
objectIdstring (uuid)sim
headerstringsim
valuesstring[]nãopadrão []
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "objectId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "header": {
      "type": "string",
      "maxLength": 200
    },
    "values": {
      "default": [],
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      }
    }
  },
  "required": [
    "objectId",
    "header"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/custom_objects.records_import_ai_column \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"objectId":"00000000-0000-0000-0000-000000000000","header":"Preço","values":["450000","820000"]}'

CLI:

node cli/atomiks.mjs custom_objects.records_import_ai_column --json '{"objectId":"00000000-0000-0000-0000-000000000000","header":"Preço","values":["450000","820000"]}'

MCP: ferramenta custom_objects_records_import_ai_column com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "candidates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "string"
          },
          "confidence": {
            "type": "string",
            "enum": [
              "high",
              "medium",
              "low"
            ]
          },
          "reason": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "customFieldId",
          "confidence",
          "reason"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "candidates"
  ],
  "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).

custom_objects.records_import_ai_column · Atomiks API