custom_objects.records_import_ai_mapping
Sugerir o mapeamento das colunas da planilha com IA. Equivale a records/import/ai-suggest-mapping do original. Manda o cabeçalho e até 5 linhas de exemplo ao modelo e devolve suggestions ({csvColumn, customFieldId}, um campo por coluna) e uncertainColumns (colunas em que a IA não teve certeza). Sem a chave da IA ou com falha, responde aiFailed: true com o motivo em reason e a tela usa o nome das colunas.
- Endpoint:
POST https://app.atomiks.com.br/api/v1/custom_objects.records_import_ai_mapping(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_mapping - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdcustom_objects.records_import_ai_mapping)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
objectId | string (uuid) | sim | |
headers | string[] | sim | |
sampleRows | string[][] | não | padrã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)$"
},
"headers": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
},
"sampleRows": {
"default": [],
"maxItems": 20,
"type": "array",
"items": {
"maxItems": 200,
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
}
}
}
},
"required": [
"objectId",
"headers"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/custom_objects.records_import_ai_mapping \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"objectId":"00000000-0000-0000-0000-000000000000","headers":["Endereço","Preço"],"sampleRows":[["Rua A, 10","450000"]]}'CLI:
node cli/atomiks.mjs custom_objects.records_import_ai_mapping --json '{"objectId":"00000000-0000-0000-0000-000000000000","headers":["Endereço","Preço"],"sampleRows":[["Rua A, 10","450000"]]}'MCP: ferramenta custom_objects_records_import_ai_mapping com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"suggestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"csvColumn": {
"type": "string"
},
"customFieldId": {
"type": "string"
}
},
"required": [
"csvColumn",
"customFieldId"
],
"additionalProperties": false
}
},
"uncertainColumns": {
"type": "array",
"items": {
"type": "string"
}
},
"aiFailed": {
"type": "boolean"
},
"reason": {
"type": [
"string",
"null"
]
}
},
"required": [
"suggestions",
"uncertainColumns",
"aiFailed",
"reason"
],
"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).