Documentation

Everything you need to get started with Claripix

Quick Start Guide

1. Create an Account

Sign up for a free account to get started. No credit card required for the free tier.

Create Account

2. Upload an Image

Navigate to the Editor and drag & drop an image or click to upload. We support JPEG, PNG, WebP, and GIF formats up to 100MB.

3. Process Your Image

Choose from resize, convert, optimize, or AI features. Adjust settings and click process. Download your result instantly.

Creating an Account

  1. Visit the Registration Page: Click "Get Started" or navigate to /register
  2. Enter Your Details: Provide your email address and create a secure password (minimum 8 characters)
  3. Verify Your Email: Check your inbox for a verification link and click to confirm
  4. Complete Your Profile: Add optional details like your name and company
  5. Start Using Claripix: You're ready to process images!

Understanding Plans

Free

$0/mo

  • ✓ 50 images/month
  • ✓ Basic resize & convert
  • ✓ 10MB max file size
  • ✓ Standard processing

Pro

$19/mo

  • ✓ 1,000 images/month
  • ✓ All processing features
  • ✓ AI enhancements
  • ✓ 50MB max file size
  • ✓ Priority processing
  • ✓ API access

Enterprise

$99/mo

  • ✓ Unlimited images
  • ✓ All Pro features
  • ✓ 100MB max file size
  • ✓ Dedicated support
  • ✓ Custom integrations
  • ✓ SLA guarantee

View full pricing details →

Dashboard Overview

Your dashboard is the central hub for managing your images and account. Here's what you'll find:

📊 Usage Statistics

Track your monthly image processing usage and remaining quota

🖼️ Recent Images

Quick access to your recently processed images

⚡ Quick Actions

One-click access to common tasks like upload and batch processing

🔑 API Keys

Manage your API keys for programmatic access (Pro & Enterprise)

Resizing Images

Resize images to exact dimensions or scale proportionally while maintaining quality.

Resize Options

  • Exact Dimensions: Specify width and height in pixels
  • Scale by Percentage: Resize to 50%, 75%, 150%, etc.
  • Fit Within: Scale to fit within max dimensions while preserving aspect ratio
  • Fill: Resize and crop to fill exact dimensions
// API Example
POST /api/v1/images/resize
{
  "width": 800,
  "height": 600,
  "mode": "fit", // fit, fill, exact
  "quality": 90
}

Format Conversion

Convert images between formats with optimized settings for each type.

JPEG

Best for photographs. Adjustable quality 1-100.

PNG

Lossless compression. Supports transparency.

WebP

Modern format. 25-35% smaller than JPEG/PNG.

GIF

Animated images. Limited to 256 colors.

Image Optimization

Reduce file size while maintaining visual quality for faster web loading.

Optimization Levels

  • Lossless: No quality loss, moderate size reduction (10-20%)
  • Balanced: Minimal quality loss, good size reduction (30-50%)
  • Maximum: Some quality loss, maximum size reduction (50-80%)

Batch Processing

Process multiple images at once with the same settings. Available on Pro and Enterprise plans.

How to Use

  1. 1. Navigate to the Batch Processing page
  2. 2. Upload multiple images (up to 100 at once)
  3. 3. Select your processing options
  4. 4. Click "Process All" and download as ZIP

Try Batch Processing →

AI Enhancement

Automatically improve image quality using AI-powered algorithms.

Auto-Enhance

One-click improvement of brightness, contrast, and color balance

Noise Reduction

Remove grain and noise while preserving detail

Sharpening

Intelligent edge enhancement for crisp images

Color Correction

Fix white balance and color cast issues

Background Removal

Remove backgrounds from images with AI precision. Perfect for product photos and portraits.

Features

  • • Automatic subject detection
  • • Hair and fine edge preservation
  • • Transparent PNG output
  • • Optional background replacement

Smart Cropping

AI-powered cropping that automatically identifies and focuses on the most important parts of your image.

Crop Modes

  • Face Detection: Automatically center on detected faces
  • Subject Focus: Identify and focus on the main subject
  • Rule of Thirds: Apply compositional guidelines
  • Custom Aspect Ratios: 1:1, 4:3, 16:9, or custom

Image Upscaling

Increase image resolution using AI while maintaining sharpness and detail.

2x

Double resolution

4x

Quadruple resolution

8x

Enterprise only

Caption Generation

Generate descriptive captions and alt text for your images using AI.

Use Cases

  • Accessibility: Generate alt text for screen readers
  • SEO: Create descriptive image metadata
  • Social Media: Auto-generate engaging captions
  • Cataloging: Describe product images automatically

API Authentication

All API requests require authentication using Bearer tokens.

// Include your API key in the Authorization header
curl -X GET https://api.claripix.io/v1/user \
  -H "Authorization: Bearer YOUR_API_KEY"

Security Note: Never expose your API key in client-side code. Always make API calls from your server.

Image Endpoints

POST /v1/images/resize

Resize an image to specified dimensions.

{
  "image": "base64_or_url",
  "width": 800,
  "height": 600,
  "mode": "fit" // fit, fill, exact
}

POST /v1/images/convert

Convert image to a different format.

{
  "image": "base64_or_url",
  "format": "webp", // jpeg, png, webp, gif
  "quality": 85
}

POST /v1/images/optimize

Optimize image for web delivery.

{
  "image": "base64_or_url",
  "level": "balanced" // lossless, balanced, maximum
}

AI Endpoints

POST /v1/ai/enhance

AI-powered image enhancement.

{
  "image": "base64_or_url",
  "enhancements": ["auto", "denoise", "sharpen"]
}

POST /v1/ai/remove-background

Remove image background.

{
  "image": "base64_or_url",
  "output_format": "png"
}

POST /v1/ai/upscale

Upscale image resolution.

{
  "image": "base64_or_url",
  "scale": 2 // 2, 4, or 8
}

Webhooks

Receive real-time notifications when image processing completes.

Webhook Payload

{
  "event": "image.processed",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "image_id": "img_abc123",
    "status": "completed",
    "result_url": "https://cdn.claripix.io/...",
    "processing_time_ms": 1250
  }
}

Tip: Configure webhooks in your dashboard under Settings → Webhooks.

Rate Limits

API rate limits vary by plan to ensure fair usage.

PlanRequests/minRequests/day
Free10100
Pro605,000
Enterprise300Unlimited

Rate Limit Headers: Check X-RateLimit-Remaining and X-RateLimit-Reset in API responses.

Need Help?

Can't find what you're looking for? Our support team is here to help.