Ver .md

custom_objects.image_upload

Enviar foto de um registro. Guarda uma imagem (JPEG, PNG, WebP ou GIF, até 10 MB; content em base64) e devolve url, o link para gravar num campo de tipo image (o link é assinado e vale 1 ano). O campo guarda uma lista de links (até 20); a primeira é a capa.

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

Entrada

CampoTipoObrigatórioNota
namestringsim
mimeTypestringsim
contentstringsim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "mimeType": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "content": {
      "type": "string",
      "minLength": 1,
      "maxLength": 14000000
    }
  },
  "required": [
    "name",
    "mimeType",
    "content"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/custom_objects.image_upload \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"fachada.png","mimeType":"image/png","content":"iVBORw0KGgo="}'

CLI:

node cli/atomiks.mjs custom_objects.image_upload --json '{"name":"fachada.png","mimeType":"image/png","content":"iVBORw0KGgo="}'

MCP: ferramenta custom_objects_image_upload com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    }
  },
  "required": [
    "url"
  ],
  "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).