Skip to content
smallPict

Endpoint de Otimização de Imagens

Referência técnica oficial para o endpoint principal de processamento de imagens POST /v1/optimize.

O endpoint principal para otimizar, transcodificar, reduzir escala e redimensionar imagens é:

POST https://api.smallpict.app/v1/optimize
(Alias: POST https://api.smallpict.app/v1/convert)


Formato da Requisição (Payload JSON)

HTTP
POST /v1/optimize HTTP/1.1Host: api.smallpict.appX-API-Key: sp_sdk_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f1a0bX-Timestamp: 1716301234X-Signature: 3a9f8b2c4d6e8a0f1b3c5d7e9f2a4b6c8d0e1f3a5b7c9d1e3f5a7b9c1d3e5f7aContent-Type: application/jsonIdempotency-Key: c9b8a7f6-e5d4-4c3b-2a1f-0e9d8c7b6a5f

Esquema do Corpo da Requisição

JSON
{  "filename": "hero-banner.jpg",  "mime_type": "image/jpeg",  "filesize": 1654200,  "options": {    "format": "avif",    "quality": 80,    "max_dimension": 1600,    "max_width": 1920,    "max_height": 1080,    "lossless": false,    "strip_metadata": true  }}
CampoTipoObrigatórioDescrição
filenamestringSimNome original do arquivo de imagem (ex.: banner.png)
mime_typestringSimTipo MIME (ex.: image/jpeg, image/png, image/webp)
filesizeintegerSimTamanho total do arquivo em bytes (deve ser > 0)
options.formatstringNãoFormato de destino: avif, webp, original / keep, jpg, png (Padrão: webp)
options.qualityintegerNãoQualidade de compressão entre 1 e 100 (Padrão: 80)
options.max_dimensionintegerNãoLimite proporcional para o lado mais longo em pixels (ex.: 1600, 1920, 2048, 2560)
options.max_widthintegerNãoLimite máximo de largura em pixels
options.max_heightintegerNãoLimite máximo de altura em pixels
options.losslessbooleanNãoAtivar compressão sem perda pixel a pixel (Padrão: false)
options.strip_metadatabooleanNãoRemover metadados EXIF da câmera e perfis de cor (Padrão: true)

Parâmetros Diretos do Transformador de Imagens

Rotas diretas do transformador em nuvem aceitam parâmetros de URL para conversão e redimensionamento imediatos:

GET https://api.smallpict.app/v1/transform?url=...&format=webp&quality=80&max_dimension=1600

  • ?format=avif|webp|original
  • ?quality=1..100
  • ?max_dimension=1600
  • ?max_width=1920
  • ?max_height=1080

Resposta do Servidor (200 OK)

Após a inicialização bem-sucedida, a SmallPict retorna uma URL de upload pré-assinada segura e um identificador de tarefa:

Response · 200 OK
{  "upload_url": "https://upload.smallpict.app/uploads/a1b2c3d4/hero-banner.jpg?signature=...",  "job_id": "job-a1b2c3d4",  "object_key": "uploads/a1b2c3d4/hero-banner.jpg",  "status": "queued"}

Envie os bytes da imagem para upload_url com uma requisição HTTP PUT e depois consulte o status da tarefa. Use o link de upload seguro exatamente como foi retornado: ele expira em pouco tempo e vale apenas para este upload.


Consulta do Status da Tarefa

Acompanhe o progresso da conversão através de:

GET https://api.smallpict.app/v1/optimize/status?job_id=job-a1b2c3d4

Resposta de Conclusão (200 OK)

Response · 200 OK
{  "job_id": "job-a1b2c3d4",  "status": "completed",  "url": "https://cdn.smallpict.app/opt/hero-banner.avif",  "format": "avif",  "bytes_saved": 1456200,  "savings_percentage": 88.03,  "created_at": "2026-08-23T08:00:00Z",  "updated_at": "2026-08-23T08:00:01Z"}